-
Notifications
You must be signed in to change notification settings - Fork 4
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 documentation #286
Conversation
…oject/pvcompare into feature/documentation_issue_163
@MaGering I've included some more changes in the same PR so that it's easier to review;) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you for improving the docs! :) There are a few typos I found during the review. The content looks good to me!
A typo in README.rst in line 74 / 75 that I couldn't correct in review mode. It should be:
You can download the open source [...]
Co-authored-by: MaGering <52790556+MaGering@users.noreply.github.com>
Thank you @MaGering for correcting the typos and some expressions :)
done with bdafd38 |
Fix #163, #159
Changes proposed in this pull request:
parameters.rst
to make references of these sections possible in RTDREADME.rst
The following steps were realized, as well (required):
EXECUTE_TESTS_ON=master pytest
)Also the following steps were realized (if applies):
Please mark above checkboxes as following:
In case of an error due to linting, run
black . --exclude docs/
and push your changes.Note that in case you do not fix a whole issue you should start your PR with
Address #xyz
.For more information on how to contribute check the CONTRIBUTING.md.