[GitHub] [arrow] jorisvandenbossche commented on a diff in pull request #14260: ARROW-17753: [Python][Docs] Document cleaning for fixing build environment issues

[GitBox <gi...@apache.org>]

jorisvandenbossche commented on code in PR #14260:
URL: https://github.com/apache/arrow/pull/14260#discussion_r982101900


##########
docs/source/developers/python.rst:
##########
@@ -636,6 +636,52 @@ Caveats
 
 The Plasma component is not supported on Windows.
 
+Deleting stale build artifacts
+==============================
+
+When there have been changes to the structure of the Arrow C++ library or Pyarrow,
+a thorough cleaning is recommended as a first attempt to fixing build errors.
+
+.. note::
+
+   It is not necessarily intuitive from the error itself that the problem is due to stale artifacts.
+   Example of a build error from stale artifacts is "Unknown CMake command "arrow_keep_backward_compatibility".
+
+To delete stale Arrow C++ build artifacts:
+
+.. code-block::
+
+  $ rm -rf arrow/cpp/build

Review Comment:
   @anjakefala to clarify: in practice it doesn't matter how many spaces you are using here (the above also works perfectly fine), but the rest of this file is consistently using 3 spaces for the initial indentation in code blocks



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org