DOC - update docs on building from source - #2282
Conversation
rcap107
left a comment
There was a problem hiding this comment.
Thanks for the PR!
I think the install section can be shortened more, to the point where it's a link to the repo and the instructions on moving to the cloned repo folder and installing in the current environment with pip -e .
The rest of the instructions on how to fork the project and cloning the fork are only relevant to contributors, so I think that can also be moved to the contributing page.
Of course, the installation page should have a link to the contribution page.
|
|
||
| .. code:: sh | ||
|
|
||
| UserWarning: Only pandas and polars DataFrames are supported, but input is a Numpy array. Please convert Numpy arrays to DataFrames before passing them to skrub transformers. Converting to pandas DataFrame with columns ['0', '1', …]. |
There was a problem hiding this comment.
this section can be removed, it was addressed in #1908
| git commit -m "my message" | ||
| git push --set-upstream origin my-branch-name-eg-fix-issue-123 | ||
|
|
||
| Enabling pre-commit hooks ensures code style consistency by triggering checks (mainly formatting) every time you run a ``git commit``. |
There was a problem hiding this comment.
Can you add a section header about pre-commit here? The switch from creating the branch to pre-commit is very abrupt like this
There was a problem hiding this comment.
This section can also be moved to the contributing section
|
@rcap107 Please review the changes. |
Documentation Update Pull Request
Description
This PR modifies _docs/install.rst document including necessary installation instructions. Rest of the information is transferred to CONTRIBUTING.rst file, in the section named "Setting up the environment".
Addresses #2116