From 70f90b7020370fe257e308169bb9363fdadec215 Mon Sep 17 00:00:00 2001 From: Stefanie Molin <24376333+stefmolin@users.noreply.github.com> Date: Fri, 18 Aug 2023 22:29:05 +0200 Subject: [PATCH] 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. --- doc/source/development/contributing_codebase.rst | 2 +- doc/source/development/contributing_environment.rst | 10 +++++++++- 2 files changed, 10 insertions(+), 2 deletions(-) diff --git a/doc/source/development/contributing_codebase.rst b/doc/source/development/contributing_codebase.rst index c06c0f8703d11..41f4b4d5783ea 100644 --- a/doc/source/development/contributing_codebase.rst +++ b/doc/source/development/contributing_codebase.rst @@ -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 `_) 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:: diff --git a/doc/source/development/contributing_environment.rst b/doc/source/development/contributing_environment.rst index 51d0edf1859c5..0cc1fe2629e46 100644 --- a/doc/source/development/contributing_environment.rst +++ b/doc/source/development/contributing_environment.rst @@ -214,7 +214,7 @@ due to limitations in setuptools. The newer build system, invokes the meson backend through pip (via a `PEP 517 `_ 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 @@ -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