Skip to content

Fix documentation typing for astep and atime #26

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
Closed
tekktrik opened this issue Feb 16, 2022 · 1 comment · Fixed by #28
Closed

Fix documentation typing for astep and atime #26

tekktrik opened this issue Feb 16, 2022 · 1 comment · Fixed by #28

Comments

@tekktrik
Copy link
Member

The documentation now says types astep and atime correctly for linters, but not so well for library usage (since the __get__() and __set__() methods mean the actual return values are different. Not sure the correct fix, but wanted to document it for now at least.
@tekktrik
Copy link
Member Author

It's worth noting it's only happening on those class attributes that are documented,

@tekktrik tekktrik mentioned this issue Feb 17, 2022
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Use :rtype: to clarify types returned because of __get__()
1 participant
@tekktrik