Skip to content

DOC: Added pre-commit link inside the guideline for developers. #49308

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.

Sign up for GitHub

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

Merged
merged 6 commits into from
Oct 28, 2022
Merged

DOC: Added pre-commit link inside the guideline for developers. #49308

Changes from 2 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
52ad565
Added pre-commit link inside the guideline
HatimZ Oct 25, 2022
cadfcbf
Updated the Text to install pre-commit hooks.
HatimZ Oct 27, 2022
e54d39c
Changed the https link to short form link.
HatimZ Oct 27, 2022
b27b774
Merge branch 'main' into HatimZ-Doc-Fix-1
HatimZ Oct 28, 2022
cb17db1
Added a period at the end of the sentence
HatimZ Oct 28, 2022
6687498
Changed location of pre-commit text and made it optional.
HatimZ Oct 28, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions doc/source/development/contributing_environment.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -216,6 +216,8 @@ should already exist.
python setup.py build_ext -j 4
python -m pip install -e . --no-build-isolation --no-use-pep517

Be sure to also install the `pre-commit hooks <https://pandas.pydata.org/pandas-docs/stable/development/contributing_codebase.html#pre-commit>`__.
Copy link
Contributor

Choose a reason for hiding this comment

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

I think (not 100% sure) that the link should be of the form :ref:`per-commit hooks <contributing.pre-commit>`

Copy link
Contributor Author

Choose a reason for hiding this comment

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

When I write :ref:per-commit hooks <contributing.pre-commit> , it doesn't show a hyperlink text in the Preview section.
image

Copy link
Contributor

Choose a reason for hiding this comment

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

That's to be expected. If you look at similar links in that document, e.g., :ref:`Continuous Integration <contributing.ci>` , you'll see the same thing.

What you should do is build the docs locally and then you can test that the link is correct.

Copy link
Member

Choose a reason for hiding this comment

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

or you can download the artifact from the CI build https://github.com/pandas-dev/pandas/actions/runs/3337146888 (see "artifacts" at the bottom of the page)


Option 2: creating an environment using Docker
----------------------------------------------

Expand Down