Clarify terminology around aggregations #1424
Merged
+69
−52
Conversation
This file contains 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
I've done my best to remove the word "bundle", because I feel like it causes more confusion than it provides. Instead I have favoured "aggregated child events" which I think is clearer. Some general clarification around these parts of the spec.
richvdh
force-pushed
the
rav/clarify_aggregations
branch
from
dea7972
to
3d3f28c
Compare
turt2live
reviewed
Feb 28, 2023
| @@ -32,8 +32,7 @@ paths: | |||
| x-addedInMatrixVersion: "1.4" | |||
| summary: Retrieve a list of threads in a room, with optional filters. | |||
| description: |- | |||
| Paginates over the thread roots in a room, ordered by the `latest_event` of each thread root | |||
| in its bundle. | |||
| Paginates over the thread roots in a room. | |||
There was a problem hiding this comment.
The description appears to have lost some context here?
There was a problem hiding this comment.
It seemed redundant to specify the sort order here as well as in the response.
There was a problem hiding this comment.
it adds a bit of clarity without having to scroll past a whole request schema, though not all that bothered.
The summary and description should be switched if we are losing the text though: it's more awkward if the summary is longer than the description.
There was a problem hiding this comment.
Have updated a bit more, with reference to https://github.com/matrix-org/matrix-spec/blob/main/meta/documentation_style.rst#openapi.
If you still don't like it, am happy to put it back how it was.
turt2live
approved these changes
Mar 21, 2023
47 tasks
clokep
pushed a commit
to clokep/matrix-spec
that referenced
this pull request
May 3, 2023
I've done my best to remove the word "bundle", because I feel like it causes more confusion than it provides. Instead I have favoured "aggregated child events" which I think is clearer. Some general clarification around these parts of the spec.
16 tasks
16 tasks
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.
I've done my best to remove the word "bundle", because I feel like it causes more confusion than clarification. Instead I have favoured "aggregated child events" which I think is clearer.
Some general clarification around these parts of the spec.
Hopefully, fixes #1405
Preview: https://pr1424--matrix-spec-previews.netlify.app