Skip to content

Swap order of supplemental text  #481

@jautor

Description

@jautor

For better readability, when supplemental text is added for a string property with enumerations, the supplemental text should be placed after the enumeration value table. It is currently placed before the table (as it's considered part of the description text).

For example, see Certificate schema and CertificateType. There is substantial supplemental text to explain usage and examples, but with that text before the table, it's not clear that the text refers to the values of the property.

Need to evaluate whether this distinction should occur for supplemental text vs "in line" JSON description text - we don't make any distinction between those two methods of adding further text, but it could be the way to affect the output that could be explained (and controlled by the user).

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions