-
-
Notifications
You must be signed in to change notification settings - Fork 56.5k
Description
Detailed description
The last step of the Generate Documentation section of Writing Documentation says to run
make check_pylint to test Python code. This will not work for beginners who did not previously have pylint installed because check_pylint doesn't appear in the Makefile after running cmake.
Could NOT find Pylint (missing: PYLINT_EXECUTABLE) appears when running the cmake command, so the rule is skipped.
The step is slightly misleading since it does not mention this, especially for anyone who didn't know about Pylint before reading the guide. I'd like to make a PR to make it clear.
Steps to reproduce
Follow the steps under Generate documentation in the Writing Documentation tutorial without pylint installed. Running make check_pylint should output:
make: *** No rule to make target 'check_pylint'. Stop.