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

Proposal: Adopt numpydoc docstring style for consistency across Holoviz repositories #6502

Open
Azaya89 opened this issue Jan 30, 2025 · 4 comments · May be fixed by #6506
Open

Proposal: Adopt numpydoc docstring style for consistency across Holoviz repositories #6502

Azaya89 opened this issue Jan 30, 2025 · 4 comments · May be fixed by #6506
Assignees
Labels
type: enhancement Minor feature or improvement to an existing feature

Comments

@Azaya89
Copy link

Azaya89 commented Jan 30, 2025

Is your feature request related to a problem? Please describe.

I noticed that the HoloViews documentation currently uses Google-style docstrings, while several other repositories in the HoloViz ecosystem adopt NumPy-style docstrings(e.g, Panel). This inconsistency can create confusion for contributors and users who navigate across different HoloViz projects, resulting in a less cohesive developer experience.

Describe the solution you'd like

I propose migrating HoloViews documentation from Google-style docstrings to NumPy-style docstrings. This would align HoloViews with the rest of the HoloViz repositories that already follow the NumPy docstring convention. Adopting a single, consistent documentation format will simplify both development and maintenance, and provide a more uniform experience for new contributors.

See this comment #5541 (comment)

Describe alternatives you've considered

Continuing with the current Google-style docstrings: This retains the status quo but does not resolve the inconsistency with other HoloViz projects.

Additional context

By switching to the NumPy documentation style, we can leverage existing numpydoc tooling more effectively. It may also reduce overhead in maintaining multiple docstring styles and streamline automated doc generation workflows across the entire HoloViz suite.

@holoviz/holoviz-dev

@Azaya89 Azaya89 added the TRIAGE Needs triaging label Jan 30, 2025
@Azaya89 Azaya89 self-assigned this Jan 30, 2025
@Azaya89 Azaya89 changed the title Proposal: Adopt Numpydoc Docstring Style for Consistency Across Holoviz Repositories Proposal: Adopt numpydoc docstring style for consistency across Holoviz repositories Jan 31, 2025
@maximlt
Copy link
Member

maximlt commented Jan 31, 2025

FWIW I support that.

@maximlt maximlt added type: enhancement Minor feature or improvement to an existing feature and removed TRIAGE Needs triaging labels Jan 31, 2025
@philippjfr
Copy link
Member

Thanks for writing this up @Azaya89! I'm strongly in support.

@hoxbro
Copy link
Member

hoxbro commented Jan 31, 2025

I'm also entirely in favor of this!

@Azaya89
Copy link
Author

Azaya89 commented Jan 31, 2025

LFG!

@Azaya89 Azaya89 linked a pull request Feb 4, 2025 that will close this issue
@Azaya89 Azaya89 linked a pull request Feb 5, 2025 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: enhancement Minor feature or improvement to an existing feature
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants