Document correct signature for Instruments#4413
Merged
bors[bot] merged 2 commits intomicrosoft:masterfrom Jul 25, 2022
Merged
Conversation
jenshnielsen
force-pushed
the
sphinx_instrument_document_init
branch
from
fcc5e59 to
0fe9a83
Compare
Codecov Report
@@ Coverage Diff @@
## master #4413 +/- ##
=======================================
Coverage 68.38% 68.39%
=======================================
Files 275 276 +1
Lines 31021 31023 +2
=======================================
+ Hits 21215 21217 +2
Misses 9806 9806 |
jenshnielsen
force-pushed
the
sphinx_instrument_document_init
branch
from
b4c1349 to
0698846
Compare
astafan8
reviewed
Jul 25, 2022
Don't use custom metaclass when documenting to work around sphinx documenting __call__ rather than __init__
jenshnielsen
force-pushed
the
sphinx_instrument_document_init
branch
from
a4d45cd to
f27b4d1
Compare
astafan8
approved these changes
Jul 25, 2022
Collaborator
Author
|
bors merge |
Contributor
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes #4370 by not using custom metaclass when documenting to work around sphinx documenting call rather than init
This feels like a bit of a hack so not sure if its ok. Inspired by https://stackoverflow.com/questions/20843737/check-if-sphinx-doc-called-the-script