Skip to content

Client improve docs - #1656

Merged
ThomasNickerson merged 11 commits into
masterfrom
client-improve-docs
Feb 17, 2021
Merged

Client improve docs#1656
ThomasNickerson merged 11 commits into
masterfrom
client-improve-docs

Conversation

@ThomasNickerson

Copy link
Copy Markdown
Contributor

This PR includes:

  • expanded and improved README
  • conversion of existing docstrings to rst convention
  • improvement of the contents of existing docstrings
  • addition of new docstrings where they were missing
  • extensive comments in queries.py
  • addition of many examples in docstrings
  • refactoring of client.py to split formatting into a different module (to make space for examples)

@ThomasNickerson ThomasNickerson added the documentation Improvements or additions to documentation label Feb 16, 2021

@nsdeschenes nsdeschenes left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

@ThomasNickerson
ThomasNickerson merged commit f1fb729 into master Feb 17, 2021
@ThomasNickerson
ThomasNickerson deleted the client-improve-docs branch February 17, 2021 12:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants