get, now & utcnow will now use docs found in ArrowFactory #511
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 Report
@@ Coverage Diff @@
## master #511 +/- ##
=====================================
Coverage 100% 100%
=====================================
Files 14 14
Lines 3189 3227 +38
Branches 229 229
=====================================
+ Hits 3189 3227 +38
Continue to review full report at Codecov.
|
Syeberman
suggested changes
Jan 28, 2018
arrow/api.py
Outdated
|
|
||
|
|
||
| # internal default factory. | ||
| _factory = ArrowFactory() | ||
|
|
||
|
|
||
| @wraps(_factory.get) |
There was a problem hiding this comment.
@wraps does more than just insert the documentation. I'd prefer to see get.__doc__ = _factory.get.__doc__, to ensure that only the docstring is modified.
There was a problem hiding this comment.
OK Agreed -- done
Syeberman
approved these changes
Feb 10, 2018
|
Thanks @FHTMitchell! |
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.
Have taken the good documentation found in
arrow.factory.ArrowFactoryfor theget,nowandutcnowmethods and replaced the somewhat lacking documentation for the wrappers inarrow.api. Now, IDEs and REPLs will produce the better documentation when asked to.