third_party/opencv
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Using Pylint Tool to Test the python tutorial codes

Browse Source 
* Adding CMake script to check if pylint is installed
* Adding Pylint config file (to choose the tests that are enabled)
* Adding CMake script to samples/python/tutorial_code

Testing: bad-indentation, mixed-indentation, unnecessary-semicolon, unused-variable
This commit is contained in:
tribta
2017-06-29 12:42:45 +01:00
parent 9c14a2f0aa
commit b7fa6d84bc
5 changed files with 73 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
doc/tutorials/introduction/documenting_opencv/documentation_tutorial.markdown
+6 -1
View File
@@ -43,6 +43,10 @@ Generate documentation {#tutorial_documentation_generate}
make doxygen
@endcode
- Open <i>doc/doxygen/html/index.html</i> file in your favorite browser
- Test your python code:
@code{.sh}
make run_pylint_on_tutorials
@endcode
Quick start {#tutorial_documentation_quick_start}
===========
@@ -600,7 +604,8 @@ Document the function {#tutorial_documentation_steps_fun}
6. _Optional_: describe return value of the function using the _returns_ command.
7. _Optional_: add "See also" section with links to similar functions or classes
8. _Optional_: add bibliographic reference if any.
9. Generate doxygen documentation and verify results.
9. Test your code. (Python: "make run_pylint_on_tutorials")
10. Generate doxygen documentation and verify results.
Write the tutorial {#tutorial_documentation_steps_tutorial}
------------------