Clarify usage pattern of AnnotatedPartialOutputsError #439
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 ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #439 +/- ##
=======================================
Coverage 81.19% 81.19%
=======================================
Files 96 96
Lines 10931 10931
Branches 2086 2086
=======================================
Hits 8875 8875
Misses 1698 1698
Partials 358 358 ☔ View full report in Codecov by Sentry. |
parejkoj
approved these changes
Aug 28, 2024
This directs users to the annotate method for more details if the documentation is built correctly, and serves as a backup to the method docs if it's not.
kfindeisen
force-pushed
the
u/kfindeisen/annotate-doc
branch
from
4d1f932
to
bdf3aee
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 tweaks the class docstring for
AnnotatedPartialOutputsErrorto emphasize that it does not follow the usual usage pattern for exceptions.Checklist
doc/changes