search

speced / respec

A tool for creating technical documents and web standards
https://respec.org/
Other
709 stars 376 forks source link

revisionTypes is not documented #4732

Closed himorin closed 2 weeks ago

himorin commented 3 weeks ago

Description of problem

revisionTypes had introduced to wording changes and several special example markups, but not documented.

marcoscaceres commented 2 weeks ago

No need to document it. The revisions types will be picked up automatically. I've sent PR #4737 to remove revisionTypes in a non-breaking way.

We should find any spec using them and removed that. In ReSpec, we generally try to avoid using configuration options to add content to the document where it's possible to deduce what to add from the content itself.

himorin commented 2 weeks ago

Adding automatically via picking up content marking is great, and agree to close this without documenting.