Clarify wording around public room directory #2133
Closed
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: HarHarLinks <[email protected]>
Signed-off-by: HarHarLinks <[email protected]>
|
Beyond the initial scope of this PR, the C2S API also calls the room directory "Listing Rooms" and does not include an introductory paragraph to the topic, while the S2S API does have such a paragraph that both uses the term "room directory" and refers to the C2S API - a reference that given the lack of mention of the same term in a heading is not easy to follow. What is the SCT's opinion on this whole matter? Can/should I try to fix this in this/another PR? |
|
...welp, now that I've done the work, I see there is substantial overlap with #2104. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR suggest a switch to clearer wording in the API descriptions of what is commonly known as "(public) room directory", which contains "published rooms" (namely, published to the directory), to differentiate it more clearly from what is commonly known as "public rooms" (a room with the join rule = public).
Sadly, the name "publicRooms" is baked into the api; ideally it would be named similar to the user directory, however a migration path to that would be rough and certainly take an MSC.
Pull Request Checklist
Preview: https://pr2133--matrix-spec-previews.netlify.app