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

Remove docstrings from overriding methods #72

Open
lars-reimann opened this issue Mar 24, 2023 · 3 comments
Open

Remove docstrings from overriding methods #72

lars-reimann opened this issue Mar 24, 2023 · 3 comments
Labels
documentation 📖 Improvements or additions to documentation third party We need to wait for someone else

Comments

@lars-reimann
Copy link
Member

Once Griffe supports the inheritance of docstrings (mkdocstrings/griffe#96), remove docstrings that simply repeat what's written in the parent class. This affects the fit and predict methods of all Classifiers and Regressors for example.
@lars-reimann lars-reimann added documentation 📖 Improvements or additions to documentation third party We need to wait for someone else labels Mar 24, 2023
@lars-reimann lars-reimann mentioned this issue Apr 14, 2023
Closed
@zzril
Copy link
Contributor

zzril commented Jul 9, 2023

What was the issue that blocked this? #58?

@lars-reimann
Copy link
Member Author

lars-reimann commented Jul 10, 2023 •
edited
Loading

The linked issue in griffe. Unless we submit a PR there, we need to wait until this gets implemented by someone else.

@lars-reimann
Copy link
Member Author

lars-reimann commented May 5, 2024 •
edited
Loading

The downside would be that we could not add examples that are specific to the subclass.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation 📖 Improvements or additions to documentation third party We need to wait for someone else
Projects
Library
Status: 🧱 Blocked
Milestone
No milestone
Development

No branches or pull requests
2 participants
@lars-reimann @zzril