Skip to content

Commit

Permalink
Document that Python 3 is required for Clang-Tidy
Browse files Browse the repository at this point in the history
  • Loading branch information
hcho3 committed Jan 30, 2019
1 parent c0aedb6 commit 2c16f55
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions doc/contribute.rst
Original file line number Diff line number Diff line change
Expand Up @@ -178,21 +178,21 @@ from the top level source tree:

.. code-black:: bash
cd /path/to/xgboost/
python tests/ci_build/tidy.py
python3 tests/ci_build/tidy.py

The script accepts two optional integer arguments, namely --cpp and --cuda.
By default they are both set to 1. If you want to exclude CUDA source from
linting, use:

.. code-black:: bash
cd /path/to/xgboost/
python tests/ci_build/tidy.py --cuda=0
python3 tests/ci_build/tidy.py --cuda=0

Similarly, if you want to exclude C++ source from linting:

.. code-black:: bash
cd /path/to/xgboost/
python tests/ci_build/tidy.py --cpp=0
python3 tests/ci_build/tidy.py --cpp=0

********
Examples
Expand Down

0 comments on commit 2c16f55

Please sign in to comment.