Skip to main content

Forcing developers to write docstrings.

Project description

wtfd(write the f*ing docs) is a Django library that forces developers to write docstrings.

Developed on Django 1.5.8

Installation

  1. pip install django_wtfd
  2. 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.

Project details


Release history Release notifications

This version
History Node

0.1.4

History Node

0.1.3

History Node

0.1.2

History Node

0.1.1

History Node

0.1

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
django_wtfd-0.1.4.tar.gz (4.8 kB) Copy SHA256 hash SHA256 Source None Jun 3, 2014

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page