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

docs: Update docstrings to numpydoc style #6506

Merged
merged 25 commits into from
Feb 20, 2025
Merged

Conversation

Azaya89
Copy link
Contributor

@Azaya89 Azaya89 commented Feb 4, 2025

fixes #6502

  • converts all public API docstrings to use numpydoc format

@Azaya89 Azaya89 self-assigned this Feb 4, 2025
@Azaya89 Azaya89 changed the title Update docstrings to numpydoc style docs: Update docstrings to numpydoc style Feb 4, 2025
Copy link

codecov bot commented Feb 4, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 88.76%. Comparing base (d12d3df) to head (eee560d).
Report is 4 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #6506   +/-   ##
=======================================
  Coverage   88.76%   88.76%           
=======================================
  Files         323      323           
  Lines       68734    68734           
=======================================
  Hits        61013    61013           
  Misses       7721     7721           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@Azaya89 Azaya89 marked this pull request as ready for review February 18, 2025 16:42
@Azaya89 Azaya89 requested review from hoxbro and philippjfr and removed request for hoxbro February 18, 2025 16:43
Copy link
Member

@hoxbro hoxbro left a comment

Choose a reason for hiding this comment

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

I skimmed through the code. Looks like tab is wrongly used in some places.

I think this can be fixed with ruff rules: my suggestion would be something like these rules to start with: ruff check holoviews/ --select=D --ignore=D1,D205,D400,D401,D404

And setting the convention to numpy:

[tool.ruff.lint.pydocstyle]
convention = "numpy"

@Azaya89
Copy link
Contributor Author

Azaya89 commented Feb 19, 2025

I have no idea why the unit tests on 313 are failing now :(

@hoxbro
Copy link
Member

hoxbro commented Feb 19, 2025

I have no idea why the unit tests on 313 are failing now :(

Not related to this PR. Will take a look at it now.

@Azaya89 Azaya89 merged commit 01a80f2 into holoviz:main Feb 20, 2025
14 checks passed
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.

Proposal: Adopt numpydoc docstring style for consistency across Holoviz repositories
2 participants