Format Application Service schema #2131
Conversation
Signed-off-by: Kai A. Hiller <[email protected]>
Signed-off-by: Kai A. Hiller <[email protected]>
Signed-off-by: Kai A. Hiller <[email protected]>
| @@ -19,10 +19,13 @@ items: | |||
| properties: | |||
| regex: | |||
| type: string | |||
| description: A POSIX regular expression defining which values this namespace includes. | |||
| description: >- | |||
There was a problem hiding this comment.
removes spurious line breaks in the descriptions by switching from literal strip (|-) to folded strip (>-) YAML string representation (https://yaml-multiline.info/)
The descriptions are written using Markdown (just like most of the spec) so we don't really care about "spurious" line breaks, they should be removed by the Markdown parser.
In my opinion, switching to the folded strip is worse, because the text does not behave as Markdown. For example we need to put 2 empty lines between paragraphs.
There was a problem hiding this comment.
element-hq/synapse#17892 (comment) is relevant to this discussion. I expect whatever solution we end up using there, can be useful here.
There was a problem hiding this comment.
Changes LGTM, other than the outstanding discussion at https://github.com/matrix-org/matrix-spec/pull/2131/files#r2038004161
Minor formatting of the Application Service schema files. This PR
|-) to folded strip (>-) YAML string representation (https://yaml-multiline.info/)Pull Request Checklist