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.

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

Many updates to documentation, add docstyle linting #46

Merged
merged 9 commits into from
Nov 2, 2023

Conversation

tlambert03
Copy link
Member

@tlambert03 tlambert03 commented May 12, 2023

This PR makes a lot of updates to the documentation,

  • uses sphinx.ext.napoleon to properly parse docstrings
  • applies linting to documentation using pydocstyle, enforcing style consistency (including PEP257 style enforcing that the first line of the docstring fits on a single line)
  • adds intersphinx links to external docs/classes
  • adds sphinx_autodoc_typehints to docs deps and removes duplicated type info from docstrings Args sections (that plugin can pull them directly from the signatures)

example parameters section before this PR:

Screen Shot 2023-05-17 at 5 04 31 PM

example after this PR:

Screen Shot 2023-05-17 at 5 03 35 PM

@codecov-commenter
Copy link

codecov-commenter commented May 12, 2023

Codecov Report

Merging #46 (108c79e) into main (8830ca6) will decrease coverage by 0.22%.
The diff coverage is 81.81%.

@@            Coverage Diff             @@
##             main      #46      +/-   ##
==========================================
- Coverage   92.86%   92.65%   -0.22%     
==========================================
  Files          32       32              
  Lines         757      762       +5     
==========================================
+ Hits          703      706       +3     
- Misses         54       56       +2     
Files Coverage Δ
motile/constraints/constraint.py 100.00% <ø> (ø)
motile/constraints/expression.py 92.50% <ø> (ø)
motile/constraints/max_children.py 100.00% <ø> (ø)
motile/constraints/max_parents.py 100.00% <ø> (ø)
motile/constraints/pin.py 100.00% <ø> (ø)
motile/constraints/select_edge_nodes.py 100.00% <ø> (ø)
motile/costs/appear.py 100.00% <ø> (ø)
motile/costs/costs.py 85.71% <ø> (ø)
motile/costs/disappear.py 100.00% <ø> (ø)
motile/costs/edge_distance.py 47.05% <ø> (ø)
... and 17 more

@tlambert03 tlambert03 changed the title add docstyle linting, wip add docstyle linting May 17, 2023
@tlambert03 tlambert03 changed the title add docstyle linting Many updates to documentation, add docstyle linting May 17, 2023
@tlambert03 tlambert03 merged commit adf70fe into funkelab:main Nov 2, 2023
10 of 12 checks passed
@tlambert03 tlambert03 deleted the docstyle branch November 2, 2023 16:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants