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

Type hint mixin base class, fix some more minor style and typing issues #100

Merged
merged 2 commits into from
Oct 21, 2024

Conversation

theOehrly
Copy link
Contributor

@theOehrly theOehrly commented Aug 14, 2024

Allows type checkers to detect the AutosummaryDocumenter as a mixin that has all the instance attributes of a any class that subclasses the Documenter base class. This makes the IDE go less crazy about accessing undefined variables and potentially allows stronger type checking/linting in the future.

Also, some more minor fixes.

WIP, maybe some more changes to come in the next few days. Just FYI for now.

Copy link

codecov bot commented Aug 14, 2024

Codecov Report

Attention: Patch coverage is 83.33333% with 1 line in your changes missing coverage. Please review.

Project coverage is 60.38%. Comparing base (6834615) to head (40871cc).
Report is 7 commits behind head on master.

Files Patch % Lines
autodocsumm/__init__.py 83.33% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##           master     #100      +/-   ##
==========================================
- Coverage   61.89%   60.38%   -1.51%     
==========================================
  Files           2        2              
  Lines         664      669       +5     
==========================================
- Hits          411      404       -7     
- Misses        253      265      +12     

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

@theOehrly theOehrly marked this pull request as ready for review October 14, 2024 14:37
@theOehrly
Copy link
Contributor Author

This can stay as it is, from my point of view. Nothing to add anymore.

@Chilipp Chilipp merged commit 0286ca8 into Chilipp:master Oct 21, 2024
33 checks passed
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.

2 participants