Skip to content

DOC: Add information on fetching tags for contributors building pandas. #54618

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 2 commits into from
Aug 18, 2023
Merged

DOC: Add information on fetching tags for contributors building pandas. #54618

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
283253d
DOC: Add information on fetching tags for contributor build issue.
stefmolin Aug 18, 2023
1b5b2a9
DOC: Change markdown link into rST link for docs.
stefmolin Aug 18, 2023
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: 1 addition & 1 deletion doc/source/development/contributing_codebase.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -754,7 +754,7 @@ install pandas) by typing::
your installation is probably fine and you can start contributing!

Often it is worth running only a subset of tests first around your changes before running the
entire suite (tip: you can use the [pandas-coverage app](https://pandas-coverage-12d2130077bc.herokuapp.com/))
entire suite (tip: you can use the `pandas-coverage app <https://pandas-coverage-12d2130077bc.herokuapp.com/>`_)
to find out which tests hit the lines of code you've modified, and then run only those).

The easiest way to do this is with::
Expand Down
10 changes: 9 additions & 1 deletion doc/source/development/contributing_environment.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -214,7 +214,7 @@ due to limitations in setuptools.

The newer build system, invokes the meson backend through pip (via a `PEP 517 <https://peps.python.org/pep-0517/>`_ build).
It automatically uses all available cores on your CPU, and also avoids the need for manual rebuilds by
rebuilding automatically whenever pandas is imported(with an editable install).
rebuilding automatically whenever pandas is imported (with an editable install).

For these reasons, you should compile pandas with meson.
Because the meson build system is newer, you may find bugs/minor issues as it matures. You can report these bugs
Expand All @@ -228,6 +228,14 @@ To compile pandas with meson, run::
# If you do not want to see this, omit everything after --no-build-isolation
python -m pip install -ve . --no-build-isolation --config-settings editable-verbose=true

.. note::
The version number is pulled from the latest repository tag. Be sure to fetch the latest tags from upstream
before building::
Copy link
Member

Choose a reason for hiding this comment

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

Can you use code-block:: shell instead of ::?

Copy link
Member

Choose a reason for hiding this comment

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

@mroeschke FWIW, the code block just above with the install command also uses ::, so I think the current version is fine here to keep it consistent.
(if we want to generally move to use code-block:: shell, it might be better to first do a PR to change it consistently in the full file?)

Copy link
Member

Choose a reason for hiding this comment

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

Okay sure this can be a follow up


# set the upstream repository, if not done already, and fetch the latest tags
git remote add upstream https://github.com/pandas-dev/pandas.git
git fetch upstream --tags

**Build options**

It is possible to pass options from the pip frontend to the meson backend if you would like to configure your
Expand Down