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

Fix and improve docs #72

Merged
merged 5 commits into from
May 13, 2019
Merged

Fix and improve docs #72

merged 5 commits into from
May 13, 2019

Conversation

rexwangcc
Copy link
Contributor

@rexwangcc rexwangcc commented May 13, 2019 •
edited
Loading

Purpose

Changes

  • Add --version argument to the CLI.
  • Fix a minor issue with the docstrings of wait function in API.
  • Improve the main readme:
    • Add a few sub-sections to the development section.
    • Fix some outdated docs.
  • Start to render Jupyter notebooks in Sphinx-generated docs.
  • Add a whole new CLI quickstart to the documentation.

Review Instructions

@rexwangcc
Update README.rst
5ddf57d 
Fix a style issue with the main readme file.
@rexwangcc
Update README.rst
18efb4c 
Fix another style issue with the main readme file.
jessicaway
jessicaway approved these changes May 13, 2019
View reviewed changes
Copy link
Member

@jessicaway jessicaway left a comment

Choose a reason for hiding this comment

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

looks good!

@rexwangcc rexwangcc merged commit e688df5 into master May 13, 2019
@rexwangcc rexwangcc deleted the rex-fix-and-improve-docs branch May 13, 2019 14:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jessicaway jessicaway jessicaway approved these changes

@ambrosejcarr ambrosejcarr Awaiting requested review from ambrosejcarr

@samanehsan samanehsan Awaiting requested review from samanehsan

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@rexwangcc @jessicaway