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

Don't document class attributes that are an alias to another object #101

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

theOehrly
Copy link
Contributor

Closes #69

This is WIP for now, still needs tests. And I need to check if there aren't any unfortunate side effects. I'll have a look at how Sphinx itself detects an object as an "alias" because it clearly knows. Then I'll finalize this.

Copy link

codecov bot commented Aug 14, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 60.95%. Comparing base (6834615) to head (73baf9e).
Report is 7 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master     #101      +/-   ##
==========================================
- Coverage   61.89%   60.95%   -0.95%     
==========================================
  Files           2        2              
  Lines         664      671       +7     
==========================================
- Hits          411      409       -2     
- Misses        253      262       +9     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@theOehrly
Copy link
Contributor Author

theOehrly commented Aug 15, 2024

Test added, and I switched to using a flag that ClassDocumenter already provides and uses internally to mark the attribute as alias instead of doing my own checks.

@theOehrly theOehrly marked this pull request as ready for review August 15, 2024 10:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Alias Expands Nested Class Documentation
1 participant