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

Fix locations of attributes docstrings #239

Merged
merged 8 commits into from
Apr 18, 2024
Merged

Conversation

CunliangGeng
Copy link
Member

@CunliangGeng CunliangGeng commented Apr 11, 2024

To solve the issue #232 (comment).

The docstrings of attributes are moved to from __init__ level to class level.

Other changes:

  • fix format and static typing errors
  • update settings for format and static typing check

Copy link
Member Author

CunliangGeng commented Apr 11, 2024

This stack of pull requests is managed by Graphite. Learn more about stacking.

Join @CunliangGeng and the rest of your teammates on Graphite Graphite

@CunliangGeng CunliangGeng mentioned this pull request Apr 11, 2024
@CunliangGeng CunliangGeng marked this pull request as ready for review April 12, 2024 09:27
This was referenced Apr 17, 2024
"typing_extensions",
# stub packages
"types-Deprecated",
Copy link
Contributor

Choose a reason for hiding this comment

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

What are these packages for?

Copy link
Member Author

Choose a reason for hiding this comment

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

They are stub files to provide static typing info

A stub file is a file containing a skeleton of the public interface of that Python module, including classes, variables, functions – and most importantly, their types.

It's required for mypy to check the typings of some dependencies.

Copy link
Member Author

CunliangGeng commented Apr 18, 2024

Merge activity

@CunliangGeng CunliangGeng merged commit 5921a82 into dev Apr 18, 2024
7 checks passed
@CunliangGeng CunliangGeng deleted the update_attributes_docstring branch April 18, 2024 13:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

None yet

2 participants