Skip to content

Include annotations for class properties #175

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
Merged
merged 2 commits into from
Mar 29, 2020
Merged

Include annotations for class properties #175

merged 2 commits into from
Mar 29, 2020

Conversation

postlund
Copy link
Contributor

Type annotations (when enabled) are not included in the generated documentation for members in classes marked with @property. This is an attempt to fix that.

This was referenced Mar 27, 2020
Merged
Closed
@kernc kernc force-pushed the prop_annotations branch from 461882c to 86abc5f Compare March 29, 2020 00:15
@kernc
Copy link
Member

kernc commented Mar 29, 2020

Thank you. I'll try to get a release out soon.

@kernc kernc merged commit b8758dd into pdoc3:master Mar 29, 2020
@postlund postlund deleted the prop_annotations branch March 29, 2020 07:07
@postlund
Copy link
Contributor Author

postlund commented Mar 29, 2020 •
edited
Loading

Awesome, thanks! 👍

kernc added a commit that referenced this pull request Apr 14, 2020
@kernc
BUG: Make Variable.type_annotation() work for non-properties
62c66cb 
Refs:
* b8758dd
* #175
kernc added a commit that referenced this pull request Apr 16, 2020
@kernc
ENH: Add type annotations for Variables
2f3db5f 
Now including global variables.

PEP 526 recommends instance variables should be type annotated
on the class. With source parsing involved, that's the only case
we opt to support.

Fixes: #121

Refs:
* 62c66cb
* b8758dd
* #175
@kernc kernc mentioned this pull request Jun 9, 2020
Closed
kernc added a commit that referenced this pull request Jun 25, 2020
@kernc
BUG: Fix variable type annotation in text.mako and pdf.mako
33edcab 
Refs:
* #212
* #175
* 2f3db5f
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@postlund @kernc