ironic.common.states doc out of date and partially missing

Bug #1308207 reported by aeva black
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
Ironic
Fix Released
Medium
David Shrewsbury

Bug Description

ironic/common/states.py is referenced in the online developer documentation, but none of the module constants show up because they lack inline python doc strings.

http://docs.openstack.org/developer/ironic/api/ironic.common.states.html

Furthermore, the module doc header is no longer accurate and should be updated based on current behavior.

aeva black (tenbrae)
Changed in ironic:
status: New → Triaged
tags: added: docs low-hanging-fruit
Changed in ironic:
importance: Undecided → Medium
aeva black (tenbrae)
tags: added: documentation
removed: docs
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to ironic (master)

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

Changed in ironic:
assignee: nobody → David Shrewsbury (dshrews)
status: Triaged → In Progress
aeva black (tenbrae)
Changed in ironic:
milestone: none → juno-rc1
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to ironic (master)

Reviewed: https://review.openstack.org/118467
Committed: https://git.openstack.org/cgit/openstack/ironic/commit/?id=5f670651934ded2af3556b4deb8826ec89216b16
Submitter: Jenkins
Branch: master

commit 5f670651934ded2af3556b4deb8826ec89216b16
Author: David Shrewsbury <email address hidden>
Date: Tue Sep 2 17:04:06 2014 -0400

    Update ironic states and documentation

    This adds doc strings for the various states, and updates the documentation
    header to reflect the current state of states.

    In addition, this removes the following unused states:
      - INIT
      - BUILDING
      - SUSPEND

    Change-Id: Id7493e856504f5ccf67fe7a716d748ffa7248590
    Closes-Bug: #1308207

Changed in ironic:
status: In Progress → Fix Committed
Thierry Carrez (ttx)
Changed in ironic:
status: Fix Committed → Fix Released
Thierry Carrez (ttx)
Changed in ironic:
milestone: juno-rc1 → 2014.2
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.