open-telemetry / opentelemetry.io

The OpenTelemetry website and documentation
https://opentelemetry.io
Creative Commons Attribution 4.0 International
541 stars 1.19k forks source link

Textlint: add rule for ID #3001

Closed chalin closed 1 year ago

chalin commented 1 year ago

From The Chicago Manual of Style:

"ID" is an initialism (http://www.chicagomanualofstyle.org/16/ch10/ch10_sec002.html) and should be capitalized and used without periods.

svrnm commented 1 year ago

👍 ... while looking for the PHP stuff I saw that the textlint plugin also has some defaults you can load:

https://github.com/sapegin/textlint-rule-terminology/blob/master/terms.jsonc

We could enable it and see if it fits?

chalin commented 1 year ago

Sure, let's give it a try. If we adopt it, we can trim our own ruleset.

svrnm commented 1 year ago

fixed