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

Remove :inherited-members: from most classes, and add :undoc-members: #1766

Merged
merged 1 commit into from
Feb 4, 2023

Conversation

mhsmith
Copy link
Member

@mhsmith mhsmith commented Feb 3, 2023

Removed :inherited-members: from all classes, except Widget, which inherits many of its members from Travertino. We could do this one widget at a time as we proceed, but I'd prefer to clean them all up now because it makes the docs much easier to navigate.

Added :undoc-members: to all classes that don't currently have it. All public members should have documentation, so this setting means that if we ever forget to document a member, it will still appear in the documentation, making it more useful to users, and more obvious to us that something is missing.

PR Checklist:

  • All new features have been tested
  • All new features have been documented
  • I have read the CONTRIBUTING.md file
  • I will abide by the code of conduct

@mhsmith mhsmith added the documentation An improvement required in the project's documentation. label Feb 3, 2023
Copy link
Member

@freakboy3742 freakboy3742 left a comment

Choose a reason for hiding this comment

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

👍

All makes sense; I was thinking we'd do this as part of the doc review of each widget, but it doesn't hurt to get a headstart.

I had removed undoc-members on the basis that we shouldn't ever have undocumented members - but I guess you're right that there's no problem having it there as something that should be a no-op, but if we ever forget a docstring, it's at least present in the docs.

@freakboy3742 freakboy3742 merged commit 3c36e52 into beeware:main Feb 4, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation An improvement required in the project's documentation.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants