Skip to content

Arrange a few titles #1126

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jun 15, 2022
Merged

Arrange a few titles #1126

merged 2 commits into from
Jun 15, 2022

Conversation

KitsuneRal
Copy link
Member

@KitsuneRal KitsuneRal commented Jun 14, 2022

Before this change, PublicRoomsChunk in the spec text could be found in two places (actually three but this one is identical to the first one), defining two (mostly identical but) different
schemas. Ctrl-F'ing through the spec may confuse you with the "wrong" definition. This commit gives distinct schemas distinct names; aside from PublicRoomChunk, the same story happens with the derivative of stripped_state.yaml used in space_hierarchy.yaml (it's not exactly StrippedStateEvent either).
As for the removal of PublicRoomsChunks (plural) - this title is unnecessary because the tooling would place rather self-explanatory [PublicRoomsChunk] without it, whereas the plural title ends up with no definition in the spec text.

Signed-off-by: Alexey Rusakov <Kitsune-Ral@users.sf.net>

Preview: https://pr1126--matrix-spec-previews.netlify.app

Before this change, PublicRoomsChunk in the spec text could be found in
two places (actually three but the third one is identical to the first
one), defining two (_mostly_ identical but) different schemas.
Ctrl-F'ing through the spec may confuse you with the "wrong" definition.
This commit gives distinct schemas distinct names; aside from
PublicRoomChunk, the same story happens with the derivative of
stripped_state.yaml used in space_hierarchy.yaml (it's not exactly
StrippedStateEvent either).

As for the removal of `PublicRoomsChunks` (plural) - this title is
unnecessary because the tooling would place rather self-explanatory
`[PublicRoomsChunk]` without it, whereas the plural title ends up with
no definition in the spec text.
@KitsuneRal KitsuneRal requested a review from a team as a code owner June 14, 2022 16:51
@turt2live turt2live merged commit 6adacd1 into main Jun 15, 2022
@turt2live turt2live deleted the kitsune/more-titles branch June 15, 2022 04:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants