MD to RST format errors in api specs

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

Bug Description

Automatic conversion of markdown to rst has caused formatting errors in the Tokens section.

https://github.com/openstack/keystone-specs/blob/master/api/v3/identity-api-v3.rst#tokens

Tom Cameron (drdabbles)
Changed in keystone:
assignee: nobody → Tom Cameron (tom-cameron)
Changed in keystone:
status: New → In Progress
Revision history for this message
Lance Bragstad (lbragstad) wrote :

Just curious, what parts of the token section appear out of format? Are there any other sections you're comparing to?

tags: added: documentation
Revision history for this message
Dolph Mathews (dolph) wrote :

In github's rendering, the parens after the expires_at attribute, for example, read:

  (string, ISO 8601 extended format date time with microseconds)

but the "microseconds)" is rendered onto a second line, and doesn't share the same formatting as the first part. Same is true for the parens appearing after "issued_at".

Changed in keystone:
importance: Undecided → Low
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to keystone-specs (master)

Reviewed: https://review.openstack.org/146977
Committed: https://git.openstack.org/cgit/openstack/keystone-specs/commit/?id=98f370c36f0f281f13ddd9ac9d9e71f84f80ce30
Submitter: Jenkins
Branch: master

commit 98f370c36f0f281f13ddd9ac9d9e71f84f80ce30
Author: Tom Cameron <email address hidden>
Date: Tue Jan 13 14:46:43 2015 -0600

    Fix MD to RST formatting

    Line wrapping causing github to improperly render section titles

    Closes-Bug: 1410516
    Change-Id: Ic4b7cd52d1ecdd78424cea32d3fb7341d853b66c

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.