arrow-py / arrow

🏹 Better dates & times for Python

https://arrow.readthedocs.io

Apache License 2.0

8.71k stars 673 forks source link

Doc improvements #850

Closed krisfremen closed 3 years ago

krisfremen commented 4 years ago

Pull Request Checklist

Thank you for taking the time to improve Arrow! Before submitting your pull request, please check all appropriate boxes:

[ ] 🧪 Added tests for changed code.
[ ] 🛠️ All tests pass when run locally (run tox or make test to find out!).
[ ] 🧹 All linting checks pass when run locally (run tox -e lint or make lint to find out!).
[ ] 📚 Updated documentation for changed code.
[ ] ⏩ Code is up-to-date with the master branch.

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

WIP for doc improvements and audits.

codecov[bot] commented 4 years ago

Codecov Report

Merging #850 into master will not change coverage. The diff coverage is 100.00%.

@@            Coverage Diff            @@
##            master      #850   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            9         9           
  Lines         1785      1808   +23     
  Branches       307       308    +1     
=========================================
+ Hits          1785      1808   +23

Impacted Files	Coverage Δ
arrow/constants.py	`100.00% <ø> (ø)`
arrow/api.py	`100.00% <100.00%> (ø)`
arrow/arrow.py	`100.00% <100.00%> (ø)`
arrow/factory.py	`100.00% <100.00%> (ø)`
arrow/formatter.py	`100.00% <100.00%> (ø)`
arrow/locales.py	`100.00% <100.00%> (ø)`
arrow/parser.py	`100.00% <100.00%> (ø)`
arrow/util.py	`100.00% <100.00%> (ø)`

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update ba103db...0b0e83a. Read the comment docs.

systemcatch commented 3 years ago

Hey @krisfremen not sure what the status of this PR is? If it's just a case of adding pydocstyle to pre-commit then manually fixing/improving every docstring I'm happy to do that.

krisfremen commented 3 years ago

Hey @krisfremen not sure what the status of this PR is? If it's just a case of adding pydocstyle to pre-commit then manually fixing/improving every docstring I'm happy to do that.

I did add pydocstyle, and I started going over the errors to fix them, have gotten busy with work, so I didn't get to finish it yet. I didn't want to merge it in with just the pydocstyle alone for it just to fail all the time.

krisfremen commented 3 years ago

I see some changes were introduced, I'll rebase and do a big chunk of the docstyle errors, probably tomorrow.

jadchaar commented 3 years ago

Hey @krisfremen when you are free and want to take this on again, feel free to open a new PR :).