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

Fix inconsistent list formatting in Khronos extension README.md files #2315

Merged
merged 1 commit into from
Aug 28, 2023

Conversation

aaronfranke
Copy link
Contributor

@aaronfranke aaronfranke commented Aug 24, 2023

In the current repo, the extensions have inconsistent list formatting. This PR fixes that.

Most of the files use *, but about a quarter of the list items use -. I've changed all of them to - as requested.

This PR also fixes KHR_materials_anisotropy having an ordered list instead of unordered, and fixes KHR_materials_clearcoat and KHR_materials_transmission not having the references formatted as a list.

Also, some trailing space characters were removed. These do nothing (note: they were doing something in the references, but now that they are using list formatting, the trailing spaces are no longer needed).

In this PR, I only changed the Khronos extensions in the 2.0 folder.

@javagl
Copy link
Contributor

javagl commented Aug 24, 2023

That also bugs me (not only in this repo, but everywhere (where MD is used)). I subjectively lean towards -, because the * is already "overloaded" a bit, via its use in *italic*, **bold**, and ***italic and bold*** (!) in MD, but don't have a strong preference - let's see what the main spec maintainers say.

(From a quick look at the changes, you also seem to have changed the numbered lists (1., 2....) to unnumbered lists (*). This is a change that affects the output, and may therefore be seen with more scrutiny, but again, no strong opinion on my side)

@aaronfranke
Copy link
Contributor Author

aaronfranke commented Aug 24, 2023

I'm happy to go with either * or - depending on what the maintainers prefer.

(From a quick look at the changes, you also seem to have changed the numbered lists

The only file where I did this is KHR_materials_anisotropy, because that makes more sense as an unordered list, and is consistent with the references in other files.

@emackey
Copy link
Member

emackey commented Aug 26, 2023

I'm happy to go with either * or - depending on what the maintainers prefer.

I think - might be official (for Markdown, which itself is not particularly official I guess). Also some of the automatic TOC generators (that we haven't run since the previous decade) also output - for the TOC. Let's have all the lists use minus signs.

(From a quick look at the changes, you also seem to have changed the numbered lists

The only file where I did this is KHR_materials_anisotropy, because that makes more sense as an unordered list, and is consistent with the references in other files.

As long as the reference isn't mentioned by number, I'm fine with that.

Copy link
Member

@emackey emackey left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @aaronfranke.

@lexaknyazev lexaknyazev merged commit 70b5e41 into KhronosGroup:main Aug 28, 2023
1 check passed
@aaronfranke aaronfranke deleted the list-formatting branch August 28, 2023 15:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants