comprehensive-rust icon indicating copy to clipboard operation
comprehensive-rust copied to clipboard

GitHub action to check formatting of Markdown files?

Open gendx opened this issue 2 years ago • 1 comments

In https://github.com/google/comprehensive-rust/pull/329, I'm adding some text which makes a line exceed the 80-column standard formatting of markdown files. I'm waiting for the workflows to be approved to see if they will catch the formatting mistake.

If not, it would be good to have a way to automatically format and check the markdown files (ala cargo fmt and cargo fmt --check).

gendx avatar Feb 03 '23 13:02 gendx

Yes, that's definitely something we should add — I'm thinking that we might not need to make it a check for merging (since I want to encourage people to make small drive-by commits). Instead I simply want to reformat things once in a while.

Reformatting everything is waiting on #318 since that will allow us to change the formatting of the Markdown text without affecting the translations.

mgeisler avatar Feb 09 '23 13:02 mgeisler