Audit all docstrings for style, typos and outdated info #939
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 #939 +/- ##
=======================================
Coverage 99.74% 99.74%
=======================================
Files 10 10
Lines 1944 1944
Branches 312 312
=======================================
Hits 1939 1939
Misses 4 4
Partials 1 1
Continue to review full report at Codecov.
|
jadchaar
requested review from
jadchaar and
krisfremen
and removed request for
jadchaar
systemcatch
force-pushed
the
docstring_audit
branch
from
d12f1f2
to
907a87e
Compare
|
Is this ready for review @systemcatch? |
|
Ready for a first review! |
jadchaar
requested changes
Apr 1, 2021
5 tasks
jadchaar
approved these changes
Apr 8, 2021
arrow/arrow.py
Outdated
| datetime.datetime(2013, 5, 5, 0, 0, tzinfo=tzutc()) | ||
| >>> arrow.Arrow.fromdatetime(dt, dt.tzinfo or 'US/Pacific') | ||
| <Arrow [2013-05-05T00:00:00+00:00]> | ||
| datetime.datetime(2021, 4, 7, 13, 48) |
There was a problem hiding this comment.
Should we make this an tz-aware datetime? Works both ways, just wanted to ask.
| @@ -1,3 +1,5 @@ | |||
| """Provides internationalization for arrow in over 60 languages and dialects.""" | |||
There was a problem hiding this comment.
Love the addition of the number of locales π!
arrow/util.py
Outdated
Comment on lines
1
to
4
| """ | ||
| Helpful functions used internally within arrow. | ||
|
|
||
| """ |
krisfremen
approved these changes
Apr 9, 2021
There was a problem hiding this comment.
Nice.
I had a few comments in a draft review, seems like @jadchaar covered all of them, looks good to me.
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.
Pull Request Checklist
Thank you for taking the time to improve Arrow! Before submitting your pull request, please check all appropriate boxes:
toxormake testto find out!).tox -e lintormake lintto find out!).masterbranch.If you have any questions about your code changes or any of the points above, please submit your questions along with the pull request and we will try our best to help!
Description of Changes
Closes: #819
Closes: #946