wtfd(write the f*ing docs) is a Django library that forces developers to write docstrings.
Developed on Django 1.5.8
Installation
pip install django_wtfd
Add django_wtfd to your project’s INSTALLED_APPS.
Settings
- WTFD_APPS
List of project’s apps to include in docstrings check. If its not set all the .py files in project will be checked.
- WTFD_STRICT
If set to True, checks will raise an exception in case some method/function/class is missing docstrings. Defaults to False.
Usage
To perform docstrings check, run: ./manage.py wtfd
Notes
Docstrings check skips magic methods, migrations, Meta class and modules that have ‘test’ in their name.
1 maintainer
Release files for django_wtfd 0.1.4
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| django_wtfd-0.1.4.tar.gz | 4.8 kB | Details |
Release files / django_wtfd-0.1.4.tar.gz
| Download URL | django_wtfd-0.1.4.tar.gz |
|---|---|
| Size | 4.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
d325dcde5a9e6ab8476639219a4899bc1cb067cc03603004c2bda03805aac4d9
|
|
BLAKE2b-256 checksum How to use checksums |
623ca18dfcc82037645fcf4fe1fe1dece3094b8065d5c64833f38ede5cfbfd78
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
