-
-
Notifications
You must be signed in to change notification settings - Fork 25.8k
DOC improve build instructions to be friendlier to first time contributors #21353
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
Conversation
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.
If rendered correctly, I'm happy with the nice improvement!
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.
Small comment on the alternative, otherwise LGTM
Rendering looks good. Merging. |
I'm a little confused with the docs. But, my process would be to first go to "Contributing Guide" here: But, the instructions for building from source are ("buried") in Step 5:
The "Building from Source" are the instructions that @amueller has been showing at the sprints, and what has worked, but are not very prominent. Can we add a section: Building from Source
==================== and point it to: https://scikit-learn.org/dev/developers/index.html |
Thanks for the feedback @reshamas. I agree. |
Based on the feedback of today's Data Umbrella sprint install session, I thought we can further improve our setup instructions:
wheel
package is not automatically installed in newly created virtualenvCosmetic: I also tried to use more consistent indentation levels in the bash prompts.
/cc @reshamas