DM-36162: Minor documentation fixes #317
Merged
Conversation
This file contains 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
Codecov ReportPatch and project coverage have no change.
Additional details and impacted files@@ Coverage Diff @@
## main #317 +/- ##
=======================================
Coverage 80.56% 80.56%
=======================================
Files 57 57
Lines 6389 6389
Branches 1304 1304
=======================================
Hits 5147 5147
Misses 994 994
Partials 248 248
... and 1 file with indirect coverage changes Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. ☔ View full report in Codecov by Sentry. |
TallJimbo
approved these changes
Apr 12, 2023
timj
reviewed
Apr 12, 2023
timj
reviewed
Apr 12, 2023
The docs claimed that these properties return a `list`, but they actually return a generator. Code that expects a list will not work.
kfindeisen
force-pushed
the
tickets/DM-36162
branch
from
81fbd15
to
52e1db3
Compare
|
@TallJimbo If you'd like, please take a look at da64ee7 to make sure I haven't garbled anything. |
TallJimbo
approved these changes
Apr 14, 2023
kfindeisen
force-pushed
the
tickets/DM-36162
branch
from
da64ee7
to
2b752a9
Compare
The docs have been brought in line with current DM standards, and an intersphinx link has been added for networkx types.
kfindeisen
force-pushed
the
tickets/DM-36162
branch
from
2b752a9
to
d3b240a
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This PR fixes some minor errors in the documentation of
QuantumGraph.