-
Notifications
You must be signed in to change notification settings - Fork 80
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
Adding information about updating developer environment to the developer docs #1432
Conversation
Codecov Report
@@ Coverage Diff @@
## latest #1432 +/- ##
==========================================
+ Coverage 89.27% 94.51% +5.23%
==========================================
Files 123 96 -27
Lines 18790 15299 -3491
Branches 1447 1463 +16
==========================================
- Hits 16775 14460 -2315
+ Misses 1782 606 -1176
Partials 233 233
Flags with carried forward coverage won't be shown. Click here to find out more.
Continue to review full report at Codecov.
|
Please review @ctb @luizirber |
doc/developer.md
Outdated
``` | ||
pip install -r requirements.txt | ||
``` | ||
(but they are already installed in the virtualenv created with `tox -e dev`). | ||
|
||
## Updating your developer environment | ||
|
||
To update rust to the latest version, use [`rustup update`]. |
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.
curious about the use of square brackets here - is there a reason to go with this convention? I don't think we use it anywhere else in the code base.
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.
I think I must have put it there by mistake. I'll remove it right away.
doc/developer.md
Outdated
|
||
To update rust to the latest version, use [`rustup update`]. | ||
|
||
To update your Python dependencies to the latest required for sourmash, you can run [`pip install -r requirements.txt`]. |
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.
same here.
…-info-on-updating-dev-env
…-lab/sourmash into Add-info-on-updating-dev-env
Please review @ctb @luizirber |
Thank you! |
@keyabarve can you merge? does the 'squash and merge' button appear for you? I'd be happy to have you do the honors :) |
@ctb I can see the 'squash and merge' button right below. Should I click on it to merge? Please let me know. Thanks! |
This involves modifications to
doc/developer.md
.A new heading called "Updating your developer environment" has been added just above "Running tests and checks" in
doc/developer.md
. The commands for updating Rust and Python have been added under this heading.There was a typo in the current dev docs on the line:
'ou' has been modified to 'you' here.