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

updates install instructions #294

Merged
merged 8 commits into from
Sep 25, 2024
Merged

updates install instructions #294

merged 8 commits into from
Sep 25, 2024

Conversation

billbrod
Copy link
Collaborator

Following @NickleDave's point in #238 , tells people to run pip install -e .[dev] as the default for local install, since they'll probably want the tests.

Also wraps the install target in quotes when including optional dependencies, which is necessary for zsh.

Copy link

codecov bot commented Sep 20, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

@billbrod billbrod linked an issue Sep 23, 2024 that may be closed by this pull request
Copy link
Contributor

@BalzaniEdoardo BalzaniEdoardo left a comment

Choose a reason for hiding this comment

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

I left mostly very minor comments I had after going through the install notes once again.

In general this are very good instruction, my points were almost all directed to streamlining the instructions by either "moving extra information in admonitions" or "moving content in a dedicated page".

The extra content you are adding, like explaining the editable mode, is valuable, but could make the core of the instruction a bit verbose; so I would keep the content, but as an optional side note.

docs/install.rst Show resolved Hide resolved
docs/install.rst Show resolved Hide resolved
@billbrod
Copy link
Collaborator Author

I agree with your points, went ahead and made those changes. Let me know what you think!

For now, I moved the jupyter content to a separate file; I'm going to do a bit of restructure of the docs soon, so exactly how things are arranged will change, but I agree it's separate.

Copy link
Contributor

@BalzaniEdoardo BalzaniEdoardo left a comment

Choose a reason for hiding this comment

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

all good!

@billbrod billbrod merged commit 1ed778c into main Sep 25, 2024
13 checks passed
@billbrod billbrod deleted the dev_install_instructions branch September 25, 2024 15:57
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.

TST: Test fails locally [pyOpenSci review]
2 participants