docstring param format issue

Bug #1474972 reported by David Lyle
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
django-openstack-auth
Fix Released
Low
David Lyle

Bug Description

When running 'tox -e docs' we get errors like:

/home/david-lyle/django_openstack_auth/openstack_auth/user.py:docstring of openstack_auth.user.User.is_anonymous:5: ERROR: Unknown directive type "param".

.. param:: margin

   A security time margin in seconds before end of an eventual
   authentication.
   Will return ``True`` even if authenticated but that authentication
   ends in less than ``margin`` seconds of time.
   A default margin can be set by the TOKEN_TIMEOUT_MARGIN in the
   django settings.

The formatting used for param is invalid.

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to django_openstack_auth (master)

Fix proposed to branch: master
Review: https://review.openstack.org/202222

Changed in django-openstack-auth:
status: New → In Progress
David Lyle (david-lyle)
Changed in django-openstack-auth:
milestone: none → 1.3.2
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to django_openstack_auth (master)

Reviewed: https://review.openstack.org/202222
Committed: https://git.openstack.org/cgit/openstack/django_openstack_auth/commit/?id=1524a22dcf4385ccc5091c0bf511a9ed01d45b25
Submitter: Jenkins
Branch: master

commit 1524a22dcf4385ccc5091c0bf511a9ed01d45b25
Author: David Lyle <email address hidden>
Date: Wed Jul 15 12:05:52 2015 -0600

    Fixing docstring formatting for param

    Currently, ''.. param:' is being used. The correct format for sphinx is
    ':param <name>:'

    The current format raises errors when building the docs. This patch
    corrects the formatting and eliminates the errors.

    Closes-Bug: #1474972
    Change-Id: I924f860dfe91c4c785d9c656825c31038072dd07

Changed in django-openstack-auth:
status: In Progress → Fix Committed
Changed in django-openstack-auth:
milestone: none → 1.4.0
status: Fix Committed → Fix Released
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.