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.

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

Add docstrings to all public methods #207

Open
non-Jedi opened this issue May 15, 2018 · 0 comments
Open

Add docstrings to all public methods #207

non-Jedi opened this issue May 15, 2018 · 0 comments
Labels
Api layer Client layer documentation good first issue

Comments

@non-Jedi
Copy link
Collaborator

For instance, get_display_name in api.MatrixHttpApi needs a docstring. Many others as well.

In doing this, you may run across methods that it seems should be private rather than public; in that case, please go ahead and make method call _method while raising a deprecation warning and point all code within the sdk towards _method
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Api layer Client layer documentation good first issue
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@non-Jedi