This is an automated email from the ASF dual-hosted git repository.
alenka pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/arrow.git
The following commit(s) were added to refs/heads/main by this push:
new 1807297a7a MINOR: [Python] Clarify reasoning in Python dev docs
(#46225)
1807297a7a is described below
commit 1807297a7a180765be6c66833c23abc17ca9948c
Author: Nic Crane <[email protected]>
AuthorDate: Mon Apr 28 09:48:10 2025 +0100
MINOR: [Python] Clarify reasoning in Python dev docs (#46225)
### Rationale for this change
Rephrasing a bit of language in the Python developer docs to add clarity
### What changes are included in this PR?
Adding some extra words, and a link
### Are these changes tested?
Nope
### Are there any user-facing changes?
Just to the docs
Authored-by: Nic Crane <[email protected]>
Signed-off-by: AlenkaF <[email protected]>
---
docs/source/developers/python.rst | 21 ++++++++++++++-------
1 file changed, 14 insertions(+), 7 deletions(-)
diff --git a/docs/source/developers/python.rst
b/docs/source/developers/python.rst
index 6c0ffe0c0a..8540bad691 100644
--- a/docs/source/developers/python.rst
+++ b/docs/source/developers/python.rst
@@ -409,8 +409,15 @@ to 0 or 1, see :ref:`python-dev-env-variables` below.
To set the number of threads used to compile PyArrow's C++/Cython components,
set the ``PYARROW_PARALLEL`` environment variable.
-If you wish to delete stale PyArrow build artifacts before rebuilding, navigate
-to the ``arrow/python`` folder and run ``git clean -Xfd .``.
+If you build PyArrow but then make changes to the Arrow C++ or PyArrow code,
+you can end up with stale build artifacts. This can lead to
+unexpected behavior or errors. To avoid this, you can clean the build
+artifacts before rebuilding. You can do this by running:
+
+.. code-block::
+
+ $ pushd arrow/python
+ $ git clean -Xfd .
By default, PyArrow will be built in release mode even if Arrow C++ has been
built in debug mode. To create a debug build of PyArrow, run
@@ -421,8 +428,8 @@ similarly.
Now you are ready to install test dependencies and run `Unit Testing`_, as
described above.
-To build a self-contained wheel (including the Arrow and Parquet C++
-libraries), one can set ``--bundle-arrow-cpp``:
+If you need to build a self-contained wheel (including the Arrow and Parquet
C++
+libraries), you can set ``--bundle-arrow-cpp``:
.. code-block::
@@ -438,9 +445,9 @@ Docker examples
~~~~~~~~~~~~~~~
If you are having difficulty building the Python library from source, take a
-look at the ``python/examples/minimal_build`` directory which illustrates a
-complete build and test from source both with the conda- and pip-based build
-methods.
+look at the `python/examples/minimal_build
<https://github.com/apache/arrow/tree/main/python/examples/minimal_build>`_
+directory which illustrates a complete build and test from source both with
+the conda- and pip-based build methods.
Debugging
---------
