Conversion of API specs from MD to RST resulted in bad formatting

Bug #1402824 reported by Dolph Mathews
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
OpenStack Identity (keystone)
Fix Released
Medium
Dolph Mathews

Bug Description

A significant portion of the API documentation consists of attribute definition lists, wherein a literal attribute is defined with one or more paragraphs of text, and may contain additional documentation for child attributes.

In the conversion from markdown to restructuredtext, all of these paragraphs have become separated from the attributes being defined, such that you can't necessarily tell where one attribute ends, and another begins.

Additional minor issues as a result of the conversion include:

- Some lists being rendered as literal blocks:
  https://github.com/openstack/keystone-specs/blob/master/api/v3/identity-api-v3.rst#endpoints-v3endpoints

- Some lists that were not in proper markdown format now appear as paragraphs of unbroken text (see query parameters):
  https://github.com/openstack/keystone-specs/blob/master/api/v3/identity-api-v3-os-trust-ext.rst#list-trusts

- Paragraphs not being wrapped at 79 characters (only visible in source)

Dolph Mathews (dolph)
tags: added: documentation
Changed in keystone:
assignee: nobody → Dolph Mathews (dolph)
importance: Undecided → Medium
status: New → Triaged
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to keystone-specs (master)

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

Changed in keystone:
status: Triaged → In Progress
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to keystone-specs (master)

Reviewed: https://review.openstack.org/141930
Committed: https://git.openstack.org/cgit/openstack/keystone-specs/commit/?id=0b60632f8f8d428d5f1687640db27b4d2f885265
Submitter: Jenkins
Branch: master

commit 0b60632f8f8d428d5f1687640db27b4d2f885265
Author: Dolph Mathews <email address hidden>
Date: Mon Dec 15 16:52:11 2014 -0600

    Fix RST formatting issues

    All of these issues were the results of the automated
    markdown-to-restructuredtext conversion. This is mostly just whitespace
    changes, so I did them all at once, but they affect the rendering of the
    final document considerably.

    Change-Id: I4031c50b76e759f445dc7dfdb08789de7c2abc5f
    Closes-Bug: 1402824

Changed in keystone:
status: In Progress → Fix Committed
Changed in keystone:
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.