OpenStack Compute (Nova)

fix restructuredtext formatting in docstrings that show up in the developer guide

Reported by Doug Hellmann on 2012-03-02
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
OpenStack Compute (nova)
Undecided
Doug Hellmann

Bug Description

Some of the docstrings within the Nova source use the "wrong" syntax to identify function parameters and their types. It looks like some of them are expecting to use a tool like doxygen to extract the documentation, but since we already have Sphinx generating that information it seems like we want to change the syntax to work with the autodoc feature of Sphinx.

Changed in nova:
assignee: nobody → Doug Hellmann (doug-hellmann)
status: New → In Progress

Reviewed: https://review.openstack.org/4933
Committed: http://github.com/openstack/nova/commit/b1de27f68a9f80db723c1b3545f95c5c9c8e7e9d
Submitter: Jenkins
Branch: master

commit b1de27f68a9f80db723c1b3545f95c5c9c8e7e9d
Author: Doug Hellmann <email address hidden>
Date: Mon Mar 5 14:33:40 2012 -0500

    fix restructuredtext formatting in docstrings that show up in the developer guide

    blueprint sphinx-doc-cleanup
    bug 945160

    - Correct parameter declarations, list formatting, cross-references, etc.
    - We don't need "let" in generate_autodoc_index.sh since we aren't doing math.
    - Change conf.py to not prefix class and function names with full namespace
      in generated output to save width on the screen.

    Change-Id: I9adc8681951913fd291d03e7142146e9d46841df

Changed in nova:
status: In Progress → Fix Committed
Thierry Carrez (ttx) on 2012-03-20
Changed in nova:
milestone: none → essex-rc1
status: Fix Committed → Fix Released
Thierry Carrez (ttx) on 2012-04-05
Changed in nova:
milestone: essex-rc1 → 2012.1
To post a comment you must log in.
This report contains Public information  Edit
Everyone can see this information.

Other bug subscribers

Related blueprints