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

Decide what to do with duplicated docstrings #363

Open
JoeZiminski opened this issue Apr 10, 2024 · 2 comments
Open

Decide what to do with duplicated docstrings #363

JoeZiminski opened this issue Apr 10, 2024 · 2 comments
Labels
enhancement New feature or request

Comments

@JoeZiminski
Copy link
Member 

[Niko PR comment] An idea for future consideration.

There's a lot of repetition in docstring (as in this example). I wonder if there is a way to define the text for a parameter somewhere and then just include it when needed.
@JoeZiminski JoeZiminski added the enhancement New feature or request label Apr 10, 2024
@JoeZiminski
Copy link
Member Author

matplotlib/matplotlib#9414
https://softwareengineering.stackexchange.com/questions/386755/sharing-docstrings-between-similar-functions
https://antoined.github.io/docstring-inheritance/

@JoeZiminski
Copy link
Member Author

See sphinx 'see also' admoniition as a solution to this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@JoeZiminski