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

Improve examples in docstrings #20

Open
allardbrain opened this issue May 24, 2020 · 0 comments
Open

Improve examples in docstrings #20

allardbrain opened this issue May 24, 2020 · 0 comments
Labels
cleanup good first issue Good for newcomers

Comments

@allardbrain
Copy link
Owner

Ensure that the example method call given in each docstring contains any required parameters as specified by the API documentation. For example, the update_epic_comment() method:

def update_epic_comment(self, epic_id, comment_id, data, **kwargs):
    '''Update a specific Comment on an Epic.
    https://clubhouse.io/api/rest/v3/#Update-Epic-Comment

    Example:
        from clubhouse import ClubhouseClient
        conn = ClubhouseClient(API_KEY)
        conn.update_epic_comment(123, 5, {'description': 'TEST'})
    '''
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cleanup good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

1 participant