Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Swap order of supplemental text #481

Open
jautor opened this issue Sep 3, 2024 · 0 comments
Open

Swap order of supplemental text #481

jautor opened this issue Sep 3, 2024 · 0 comments

Comments

@jautor
Copy link
Member

jautor commented Sep 3, 2024

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).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant