Skip to content

Commit

Permalink
DOC: Add information on fetching tags for contributors building panda…
Browse files Browse the repository at this point in the history
…s. (#54618)

* DOC: Add information on fetching tags for contributor build issue.

* DOC: Change markdown link into rST link for docs.
  • Loading branch information
stefmolin authored Aug 18, 2023
1 parent eb98a47 commit 70f90b7
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 2 deletions.
2 changes: 1 addition & 1 deletion doc/source/development/contributing_codebase.rst
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
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::

# 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

0 comments on commit 70f90b7

Please sign in to comment.