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

Fix errors in contributing.rst for setup #373

Merged
merged 1 commit into from
Oct 21, 2024
Merged

Fix errors in contributing.rst for setup #373

merged 1 commit into from
Oct 21, 2024

Conversation

JasonWeill
Copy link
Contributor

Fix errors in setup docs: removes a redundant pip command, and updates the repository's punctuation.

Fix errors in setup docs
Copy link
Contributor

Binder 👈 Launch a Binder on branch jupyterlab/jupyter-collaboration/JasonWeill-patch-1

@davidbrochart
Copy link
Collaborator

removes a redundant pip command

Why is it redundant?

@JasonWeill JasonWeill added the documentation Improvements or additions to documentation label Oct 17, 2024
@JasonWeill
Copy link
Contributor Author

Line 32 mentions that users need to install both node and pip before starting with installation. Line 34 starts, "Once you have installed the dependencies above …". Either we need to delete line 32 and start the instructions with installing both node and pip, or the documentation needs to presume, at the start of the code block, that the user has already installed both node and pip. The previous version of this file included instructions to install pip, but not node.

@davidbrochart
Copy link
Collaborator

But pip install --upgrade pip upgrades pip, right?

@JasonWeill
Copy link
Contributor Author

It does; is that required? As long as the user has supported versions of pip and node, they should be OK to start with the command after the "upgrade pip" command.

Copy link
Member

@jtpio jtpio left a comment

Choose a reason for hiding this comment

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

Thanks!

@jtpio jtpio merged commit b64b54b into main Oct 21, 2024
20 of 22 checks passed
@jtpio jtpio deleted the JasonWeill-patch-1 branch October 21, 2024 19:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants