How to use

How to scan

With vipyrdocs you can scan a single .py file or a whole directory!

# scan a single file
vipyrdocs sample_file.py
# scan a whole directory
vipyrdocs src

How to ignore certain rules

If some of the rules are too strict for you, that is fine! You can just kindly ask vipyrdocs to ignore them.

All you need to do is add the following comment in the line before your function or class:

# vipyrdocs: disable=<CODES>

Or you can even ignore all the rules at once by using ALL as the code:

# vipyrdocs: disable=ALL