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.

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

Merged
merged 6 commits into from
Apr 3, 2021

Conversation

keyabarve
Copy link
Contributor

@keyabarve keyabarve commented Apr 2, 2021

  • 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:

Finally, ou can also explicitly install all the Python dependencies for sourmash by running

'ou' has been modified to 'you' here.

@codecov
Copy link

codecov bot commented Apr 2, 2021

Codecov Report

Merging #1432 (57dd159) into latest (ed3c809) will increase coverage by 5.23%.
The diff coverage is 94.11%.

Impacted file tree graph

@@            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              
Flag Coverage Δ
python 94.51% <94.11%> (+0.02%) ⬆️
rust ?

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
src/sourmash/logging.py 28.70% <28.57%> (-0.01%) ⬇️
src/sourmash/lca/lca_db.py 91.34% <66.66%> (-1.09%) ⬇️
src/sourmash/sbt.py 83.65% <75.00%> (-0.49%) ⬇️
src/sourmash/sourmash_args.py 95.95% <94.23%> (+3.02%) ⬆️
src/sourmash/index.py 90.76% <96.87%> (-2.85%) ⬇️
src/sourmash/commands.py 83.33% <100.00%> (+0.69%) ⬆️
src/sourmash/lca/command_summarize.py 80.95% <100.00%> (+0.15%) ⬆️
src/sourmash/signature.py 90.73% <100.00%> (+0.97%) ⬆️
tests/test_api.py 100.00% <100.00%> (ø)
tests/test_index.py 100.00% <100.00%> (ø)
... and 30 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update ed3c809...57dd159. Read the comment docs.

@keyabarve
Copy link
Contributor Author

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`].
Copy link
Contributor

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.

Copy link
Contributor Author

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`].
Copy link
Contributor

Choose a reason for hiding this comment

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

same here.

@keyabarve
Copy link
Contributor Author

Please review @ctb @luizirber

@ctb
Copy link
Contributor

ctb commented Apr 3, 2021

Thank you!

@ctb
Copy link
Contributor

ctb commented Apr 3, 2021

@keyabarve can you merge? does the 'squash and merge' button appear for you? I'd be happy to have you do the honors :)

@keyabarve
Copy link
Contributor Author

keyabarve commented Apr 3, 2021

@ctb I can see the 'squash and merge' button right below. Should I click on it to merge? Please let me know. Thanks!

@ctb ctb merged commit 1dc9426 into latest Apr 3, 2021
@ctb ctb deleted the Add-info-on-updating-dev-env branch April 3, 2021 21:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

add information about updating dev environment to dev docs
2 participants