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

Consolidate information in __init__ docstrings to class docstrings #242

Closed
non-Jedi opened this issue Jul 1, 2018 · 0 comments
Closed

Comments

@non-Jedi
Copy link
Collaborator

non-Jedi commented Jul 1, 2018

For example, MatrixClient's docstring currently duplicates information in __init__, and both might be missing stuff as well. Convention in most codebases I've seen seems to be to consolidate docstring info for a class on the class's own docstring rather than the __init__ docstring.

Realized this while reviewing #234.

slipeer pushed a commit to slipeer/matrix-python-sdk that referenced this issue Jul 16, 2018
slipeer pushed a commit to slipeer/matrix-python-sdk that referenced this issue Jul 16, 2018
slipeer pushed a commit to slipeer/matrix-python-sdk that referenced this issue Jul 17, 2018
slipeer pushed a commit to slipeer/matrix-python-sdk that referenced this issue Jul 18, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant