Very minor: Better documentation comment on DeferredError. #469
Conversation
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
Codecov Report
@@ Coverage Diff @@
## master #469 +/- ##
==========================================
- Coverage 94.13% 93.98% -0.15%
==========================================
Files 57 57
Lines 4259 4259
==========================================
- Hits 4009 4003 -6
- Misses 250 256 +6
Continue to review full report at Codecov.
|
laurenyu
reviewed
Nov 9, 2018
src/sagemaker/utils.py
Outdated
| object is accessed in any way. Useful to allow soft-dependencies on imports, | ||
| so that the ImportError can be raised again later if code actually | ||
| relies on the missing library. | ||
| relies on the missing library. Example usage: |
There was a problem hiding this comment.
you could do an example section instead, e.g.
Examples:
try:
import obscurelib
except ImportError as e:
logging.warning("Failed to import obscurelib. Obscure features will not work.")
obscurelib = DeferredError(e)
reference: https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html
|
Good suggestion. Thanks for educating me on best documentation practices, Lauren! |
jesterhazy
approved these changes
Nov 10, 2018
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.
Issue #, if available: none
Description of changes: Just improving the docstring on a utility class.
Merge Checklist
Put an
xin the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your pull request.By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.