You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
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
The text was updated successfully, but these errors were encountered:
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
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
The text was updated successfully, but these errors were encountered: