search

rust-unofficial / patterns

A catalogue of Rust design patterns, anti-patterns and idioms
https://rust-unofficial.github.io/patterns/
Mozilla Public License 2.0
7.95k stars 362 forks source link

markdownlint: fix md004 #175

Closed MarcoIeni closed 3 years ago

simonsan commented 3 years ago

We agreed yesterday in the initial PR that we would keep the hyphens instead of the *'s.

simonsan commented 3 years ago

Not sure, are there any advantages of changing to *?

MarcoIeni commented 3 years ago

Not sure, are there any advantages of changing to *?

Of course not. This lint just checks that they are consistent across the same document. I will change to -. Anyway, if we receive a PR that contains * we should tell (either we or the markdownlint) to switch to -? Or is it just the preferred style but it's optional?

simonsan commented 3 years ago

Not sure, are there any advantages of changing to *?

Of course not. This lint just checks that they are consistent across the same document. I will change to -. Anyway, if we receive a PR that contains * we should tell (either we or the markdownlint) to switch to -? Or is it just the preferred style but it's optional?

Aaah, now I understand! :-D Thanks for clarifying!

Yeah, let's automate that for the people contributing that it's automatically switching to the corresponding style, or?

MarcoIeni commented 3 years ago

Yeah, let's automate that for the people contributing that it's automatically switching to the corresponding style, or?

The alternative is that every document has its own "bullet style": - or *.

For me it makes no difference. Both the approaches are fine, but it might be boring for a random contributor to switch from a style to the other after it wrote the entire page of the book.

Maybe ensuring the same style in each page is enough.

simonsan commented 3 years ago

Yeah, let's automate that for the people contributing that it's automatically switching to the corresponding style, or?

The alternative is that every document has its own "bullet style": - or *.

For me it makes no difference. Both the approaches are fine, but it might be boring for a random contributor to switch from a style to the other after it wrote the entire page of the book.

Maybe ensuring the same style in each page is enough.

I think if it's automatically fixable by markdownlint that would be the best option. so we have a common style over all documents. In the end it's just hypens or stars true. But if we can easily fix it by letting run one command i think it should be not a big problem also for contributors that are used to another style.

simonsan commented 3 years ago

Is this LGTM?

MarcoIeni commented 3 years ago

yes. Can you approve it?