Conversion of API specs from MD to RST resulted in bad formatting
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:/
- Some lists that were not in proper markdown format now appear as paragraphs of unbroken text (see query parameters):
https:/
- Paragraphs not being wrapped at 79 characters (only visible in source)
tags: | added: documentation |
Changed in keystone: | |
assignee: | nobody → Dolph Mathews (dolph) |
importance: | Undecided → Medium |
status: | New → Triaged |
Changed in keystone: | |
status: | Fix Committed → Fix Released |
Fix proposed to branch: master /review. openstack. org/141930
Review: https:/