Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improve documentation #33

Merged
merged 33 commits into from
Oct 11, 2020
Merged

Improve documentation #33

merged 33 commits into from
Oct 11, 2020

Conversation

oncleben31
Copy link
Member

@oncleben31 oncleben31 commented Oct 3, 2020 •
edited
Loading

Contribute to #18 by applying good practices of https://cjolowicz.github.io/posts/hypermodern-python-05-documentation/ for documentation:

  • Review of the docstrings
  • Use darglint in test suite to validate docstrings against function signatures
  • convert CONTRIBUTING and README in reST
  • Generate project and code documentation with Sphinx
  • Add Nox session to manage the documentation build

@oncleben31 oncleben31 marked this pull request as ready for review October 6, 2020 04:30
@codecov
Copy link

codecov bot commented Oct 6, 2020 •
edited
Loading

Codecov Report

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

Impacted file tree graph

@@            Coverage Diff            @@
##            master       #33   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           12        12           
  Lines          389       389           
  Branches        23        23           
=========================================
  Hits           389       389
Impacted Files Coverage Δ
src/meteofrance/model/__init__.py 100.00% <ø> (ø)
src/meteofrance/client.py 100.00% <100.00%> (ø)
src/meteofrance/exceptions.py 100.00% <100.00%> (ø)
src/meteofrance/helpers.py 100.00% <100.00%> (ø)
src/meteofrance/model/forecast.py 100.00% <100.00%> (ø)
src/meteofrance/model/picture_of_the_day.py 100.00% <100.00%> (ø)
src/meteofrance/model/place.py 100.00% <100.00%> (ø)
src/meteofrance/model/rain.py 100.00% <100.00%> (ø)
src/meteofrance/model/warning.py 100.00% <100.00%> (ø)
src/meteofrance/session.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 de8888b...a72f6b3. Read the comment docs.

Quentame
Quentame reviewed Oct 6, 2020
View reviewed changes
Copy link
Member

@Quentame Quentame left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Half of the review for now.
Will continue.

@oncleben31 oncleben31 added the documentation Improvements or additions to documentation label Oct 6, 2020
@oncleben31 oncleben31 mentioned this pull request Oct 7, 2020
Open
8 tasks
Quentame
Quentame requested changes Oct 11, 2020
View reviewed changes
Copy link
Member

@Quentame Quentame left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some words to correct

CONTRIBUTING.rst Outdated Show resolved Hide resolved
CONTRIBUTING.rst Outdated Show resolved Hide resolved
README.rst Outdated Show resolved Hide resolved
README.rst Outdated Show resolved Hide resolved
README.rst Outdated Show resolved Hide resolved
src/meteofrance/model/place.py Outdated Show resolved Hide resolved
src/meteofrance/model/rain.py Outdated Show resolved Hide resolved
src/meteofrance/model/warning.py Outdated Show resolved Hide resolved
src/meteofrance/model/warning.py Outdated Show resolved Hide resolved
src/meteofrance/model/warning.py Outdated Show resolved Hide resolved
@oncleben31
Copy link
Member Author

oncleben31 commented Oct 11, 2020 •
edited
Loading

All comments implemented. A big thank you @Quentame
You should have a free t-shirt too ;-)

@oncleben31
Add darglint in dev dependencies
d33f6dc
@oncleben31
Add darglint check in nox pre-commit session
991cea0
@oncleben31
Add darglint configuration file
1d6ba09
@oncleben31
Update python module top docstrings
96704b0
@oncleben31
Rewrite client docstrings with the Google style
5678a8d
@oncleben31
Rewrite helpers docstrings with Google style
c68566e
@oncleben31
use the term metropolitan France
d1c4243
@oncleben31
Rewrite session docstrings with the Google doc style
fe4175a
@oncleben31
Rewrite forecast model docstrings
757d6d3
@oncleben31
Rewrite picture of day model docstrings
0b4b369
@oncleben31
Rewrite place model doctstrings
011faed
@oncleben31
Add missing type information for __init__ methods
1477498
@oncleben31
Rewrite rain model doctstrings
f25f71d
@oncleben31
Rewrite warning model docstrings
8f150e6
@oncleben31
Add docstrings for __init__ methods
9794427
@oncleben31
Add sphinx to dev dependencies
60ece91
@oncleben31
Init sphinx configuration
143d00e
@oncleben31
Add nox session to generate docs
d12530e
@oncleben31
Add sphinx-autobuild to dev dependencies
b64d27e
@oncleben31
Update sphinx configuration
f3a1144
@oncleben31
Convert LICENSE in reST
9607bde
@oncleben31
Convert README to reST
3572a60
@oncleben31
Copy link
Member Author

PR rebased with master. All comments implemented. All checks OK. LGTM

@oncleben31 oncleben31 merged commit 98c9e50 into master Oct 11, 2020
@oncleben31 oncleben31 deleted the documentation branch October 11, 2020 20:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Quentame Quentame Quentame requested changes

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@oncleben31 @Quentame