Update Guides - #57
Conversation
Synchronize feature branch
This branch is addressing the R wrapper issue, so we can remove the note. Sarthak has grown the "tox usage" section into much more, so a more precise name is needed. Since R doesn't have an empty bibliography, C++ shouldn't either.
Since we ask users to refer to the C++ CLT build script for more information, I moved some technical information from this section to the script's docs. This makes sense since we shouldn't ask users to read the dev guide. Split up the intermediate/cache information so that info only appears in the section related to the tools that create them. Will reevaluate with Sarthak to determine if this is helpful. Having this section only point developers to the "list" tox subcommand is lovely. Improved the tox.ini descriptions to improve the self-documentation contained in that file.
jared321
left a comment
jared321
left a comment
There was a problem hiding this comment.
@Sarthakmistry I have made a first round of changes to the documentation. You can take control of your branch for your next iteration. After you have reviewed and updated, please let me know so that I can (hopefully) perform a thorough final review.
Sarthakmistry
left a comment
Sarthakmistry
left a comment
There was a problem hiding this comment.
I hae reviewed the changes made to developer environment documentation and nothing seems to be broken. The changes make sense.
It was important to tie cached files at the root level -- editable installations -- rather than to tox. Apparently sphinx substitutions don't work inside bold environments.
jared321
left a comment
jared321
left a comment
There was a problem hiding this comment.
Review
- Review all changes made
- Review output of
tox list -vto confirm documentation sufficient - Review all changes to documentation as rendered by RTD for this PR
- Confirm all actions passing
I would "approve" if I could. However, I can't since I created the PR.
@Sarthakmistry These are very nice additions and improvements to the Guides. It was interesting to see what you decided to highlight and detail in the documentation. Certainly all, including my future self, will benefit from this concise knowledge.
I've left some minor comments for you to address as you choose. You might want to do a final self-review of this PR since I changed quite a bit. Running through procedures in clean environments and thinking as a user would is always a good PR review exercise.
Unless you think I should review any future changes, please merge once you are happy with the PR.
2 participants
This includes filling out missing content as well as adding in new R wrapper content.