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

add information about updating dev environment to dev docs #1181

Closed
ctb opened this issue Aug 21, 2020 · 4 comments · Fixed by #1432
Closed

add information about updating dev environment to dev docs #1181

ctb opened this issue Aug 21, 2020 · 4 comments · Fixed by #1432
Labels
doc documentation content or issues good first issue

Comments

@ctb
Copy link
Contributor

ctb commented Aug 21, 2020

Under "If you’re having trouble installing or using the development environment" in the dev docs, it would be nice to have the right commands for updating.

For rust, this seems to be:

rustup update

for python, it varies, I think? you would do

pip install -e .

and/or

conda update --all

I think?

@ctb ctb added doc documentation content or issues good first issue labels Mar 4, 2021
@ctb
Copy link
Contributor Author

ctb commented Mar 4, 2021

This involves modifications to doc/developer.md.

(1) Right now we have the following text in the release docs -

You will also need a Rust installation (see Development Environment); be sure to update it to the latest version with rustup update.

This should be modified to "To update rust to the latest version, ...." added to the developer docs under a new heading`, "Updating your developer environment", just above "Running tests and checks".

(2) Also add

"To update your Python dependencies to the latest required for sourmash, you can run pip install -r requirements.txt"

(3) there is also a typo in the current dev docs,

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

'ou' should be 'you'.

@keyabarve
Copy link
Contributor

@ctb Can I work on this issue?

@ctb
Copy link
Contributor Author

ctb commented Apr 1, 2021 via email

@keyabarve
Copy link
Contributor

keyabarve commented Apr 2, 2021

@ctb I have added a new heading called "Updating your developer environment" just above "Running tests and checks" in doc/developer.md and added the commands for updating Rust and Python.
Additionally for (1), should the text "You will also need a Rust installation..." be removed from doc/release.md?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc documentation content or issues good first issue
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants