The module keystone.common.dependency is too sparsely documented.

Bug #1252428 reported by Ian Denhardt
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
OpenStack Identity (keystone)
Fix Released
Low
Ian Denhardt

Bug Description

The module is used in numerous locations, but nowhere is there a high level description of its purpose and basic usage. The module should have its docstrings improved, and it would also make sense to add a section about it to:

http://git.openstack.org/cgit/openstack/keystone/tree/doc/source/developing.rst

Ian Denhardt (a-ian)
Changed in keystone:
assignee: nobody → Ian Denhardt (a-ian)
Changed in keystone:
importance: Undecided → Critical
importance: Critical → Low
Dolph Mathews (dolph)
Changed in keystone:
status: New → Triaged
Changed in keystone:
status: Triaged → In Progress
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to keystone (master)

Reviewed: https://review.openstack.org/57039
Committed: http://github.com/openstack/keystone/commit/3a79713fc48606a302bc9f355b85c2ca1026a8fe
Submitter: Jenkins
Branch: master

commit 3a79713fc48606a302bc9f355b85c2ca1026a8fe
Author: Ian Denhardt <email address hidden>
Date: Mon Nov 18 15:23:59 2013 -0500

    Added documentation to keystone.common.dependency.

    All public attributes now have docstrings describing their interface,
    and the module has a top level docstring as well. Previously,
    documentation was very sparse.

    Closes-Bug: #1252428
    Change-Id: I9c83883a6d9ae3201c9037c979689cb82c232120

Changed in keystone:
status: In Progress → Fix Committed
Thierry Carrez (ttx)
Changed in keystone:
milestone: none → icehouse-2
status: Fix Committed → Fix Released
Thierry Carrez (ttx)
Changed in keystone:
milestone: icehouse-2 → 2014.1
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.