-
Notifications
You must be signed in to change notification settings - Fork 9
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
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅ |
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 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.
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. |
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.
all good!
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
.