Docs cleanup for contribution #561
Conversation
Codecov Report
@@ Coverage Diff @@
## master #561 +/- ##
=======================================
Coverage 98.36% 98.36%
=======================================
Files 76 76
Lines 8325 8325
=======================================
Hits 8189 8189
Misses 136 136 Continue to review full report at Codecov.
|
|
Alright @co9olguy @josh146, this one is ready for a bit of feedback, and I have a couple questions/thoughts. First, for Next up, could the changelog be more visible? I struggled to find it outside repo, and thought this line in the readme
could include a link to it as
Another couple options would be to add it to the website documentation under the contribution and/or development guide PR page(s). Happy to broaden this cleanup (outside contribution docs) on request! |
There was a problem hiding this comment.
Thanks for this contribution @Aaron-Robertson! Especially a docs cleanup 💯
First, for pytest-randomly and pytest-mock I included links to each of their githubs, since pypi lists it as the homepage for both. Preference for github or pypi links?
GitHub is preferred over PyPI 🙂
Next up, could the changelog be more visible? I struggled to find it outside repo, and thought this line in the readme could include a link to it.
The changelog is actually already available on the website, however it is labelled 'release notes': https://strawberryfields.readthedocs.io/en/stable/development/release_notes.html
But it would definitely be worthwhile to have a link in the readme!
| Available channels: | ||
|
|
||
| * `#strawberryfields`: For general discussion regarding Strawberry Fields | ||
| * `#sf_projects`: For discussion of research ideas and projects built on Strawberry Fields | ||
| * `#sf_bugs`: For discussion of any bugs and issues you run into using Strawberry Fields | ||
| * `#sf_interactive`: For discussion relating to the [Strawberry Fields Interactive](https://strawberryfields.ai) web application | ||
| * `#sf_docs`: For discussion of the Strawberry Fields [documentation](https://strawberryfields.readthedocs.io) |
| The Strawberry Fields test suite requires `pytest <https://docs.pytest.org/en/latest/>`_, `pytest-cov <https://pytest-cov.readthedocs.io/en/latest/>`_, `pytest-randomly <https://github.com/pytest-dev/pytest-randomly>`_, and `pytest-mocks <https://github.com/pytest-dev/pytest-mock/>`_ for coverage reports. These can be installed via ``pip``: | ||
| :: | ||
|
|
||
| $ pip install pytest pytest-cov | ||
| $ pip install pytest pytest-cov pytest-randomly pytest-mock |
|
Thanks for the review @josh146! I added the changelog to the readme, and thought of one last question. Any desire to run Could make a small development guide section to install |
|
Perfect, thanks @Aaron-Robertson!
If you were interesting in tackling this one as well, that would be great :) I'll merge this in now, and best to make a new PR (especially if it is for adding new content). |
Context:
Cleanup documentation for ease of contribution based on this slack conversation.
Description of the Change:
Benefits:
Makes it easier for new contributors.
Possible Drawbacks:
N/A
Related GitHub Issues:
N/A