Skip to content

Commit 70f90b7

Browse files
authored
DOC: Add information on fetching tags for contributors building pandas. (#54618)
* DOC: Add information on fetching tags for contributor build issue. * DOC: Change markdown link into rST link for docs.
1 parent eb98a47 commit 70f90b7

File tree

2 files changed

+10
-2
lines changed

2 files changed

+10
-2
lines changed

doc/source/development/contributing_codebase.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -754,7 +754,7 @@ install pandas) by typing::
754754
your installation is probably fine and you can start contributing!
755755

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

760760
The easiest way to do this is with::

doc/source/development/contributing_environment.rst

+9-1
Original file line numberDiff line numberDiff line change
@@ -214,7 +214,7 @@ due to limitations in setuptools.
214214

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

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

231+
.. note::
232+
The version number is pulled from the latest repository tag. Be sure to fetch the latest tags from upstream
233+
before building::
234+
235+
# set the upstream repository, if not done already, and fetch the latest tags
236+
git remote add upstream https://github.com/pandas-dev/pandas.git
237+
git fetch upstream --tags
238+
231239
**Build options**
232240

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

0 commit comments

Comments
 (0)