Forcing developers to write docstrings.
wtfd(write the f*ing docs) is a Django library that forces developers to write docstrings.
Developed on Django 1.5.8
- pip install django_wtfd
- Add django_wtfd to your project’s INSTALLED_APPS.
- List of project’s apps to include in docstrings check. If its not set all the .py files in project will be checked.
- If set to True, checks will raise an exception in case some method/function/class is missing docstrings. Defaults to False.
To perform docstrings check, run: ./manage.py wtfd
- Docstrings check skips magic methods, migrations, Meta class and modules that have ‘test’ in their name.