arrow-py / arrow

🏹 Better dates & times for Python
https://arrow.readthedocs.io
Apache License 2.0
8.71k stars 673 forks source link

Audit all docstrings for style, typos and outdated info #939

Closed systemcatch closed 3 years ago

systemcatch commented 3 years ago

Pull Request Checklist

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

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: https://github.com/arrow-py/arrow/issues/819 Closes: #946

codecov[bot] commented 3 years ago

Codecov Report

Merging #939 (996d047) into master (57c67d0) will not change coverage. The diff coverage is n/a.

Impacted file tree graph

@@           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           
Impacted Files Coverage Δ
arrow/arrow.py 98.99% <ø> (ø)
arrow/constants.py 100.00% <ø> (ø)
arrow/factory.py 100.00% <ø> (ø)
arrow/formatter.py 100.00% <ø> (ø)
arrow/locales.py 100.00% <ø> (ø)
arrow/parser.py 100.00% <ø> (ø)
arrow/util.py 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 57c67d0...996d047. Read the comment docs.

jadchaar commented 3 years ago

Is this ready for review @systemcatch?

systemcatch commented 3 years ago

Ready for a first review!