Skip to content
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

Clarify the order events in chunk are returned in for /messages #2069

Merged
merged 3 commits into from Jun 4, 2019

Conversation

Projects
3 participants
@bwindels
Copy link
Contributor

commented Jun 3, 2019

Documenting a confusion I ran into recently. Might need some help with the wording.

@bwindels bwindels requested a review from matrix-org/spec-core-team Jun 3, 2019

@turt2live
Copy link
Member

left a comment

This also needs a changelog entry: https://github.com/matrix-org/matrix-doc/blob/master/CONTRIBUTING.rst#adding-to-the-changelog

(basically take your PR title, add a full stop to the end, and put that into 2069.clarification)

Show resolved Hide resolved api/client-server/message_pagination.yaml Outdated

@turt2live turt2live added the Matrix 1.0 label Jun 3, 2019

@turt2live turt2live added this to To add to spec in Matrix 1.0 workflow via automation Jun 3, 2019

@turt2live turt2live moved this from To add to spec to In progress in Matrix 1.0 workflow Jun 3, 2019

@bwindels bwindels force-pushed the bwindels/messages-chunk-order branch from a15d347 to 8b28972 Jun 4, 2019

@bwindels bwindels requested a review from turt2live Jun 4, 2019

@@ -103,7 +103,10 @@ paths:
chunk:
type: array
description: |-
A list of room events.
A list of room events. The order depends on the ``dir`` parameter.
For ``dir=b`` events will be in reverse-chronological order,

This comment has been minimized.

Copy link
@uhoreg

uhoreg Jun 4, 2019

Member

I'm not sure if "chronological" is the right term here, since it implies that it is based on some sort of time, which it may not be. But at the same time, I can't think of a better term to use. If nobody else can think of a better term, then I guess "chronological" is good enough.

This comment has been minimized.

Copy link
@bwindels

bwindels Jun 4, 2019

Author Contributor

fwiw, the documentation of events_before and events_after for /context uses the same terms.

This comment has been minimized.

Copy link
@turt2live

turt2live Jun 4, 2019

Member

We've been using "chronological" because we haven't really introduced the term "stream ordering" in the spec. Stream ordering would be the correct term here though, if we used it throughout.

@turt2live turt2live merged commit 9dd171a into master Jun 4, 2019

8 checks passed

buildkite/matrix-doc Build #190 passed (56 seconds)
Details
ci/circleci: build-dev-scripts Your tests passed on CircleCI!
Details
ci/circleci: build-docs Your tests passed on CircleCI!
Details
ci/circleci: build-swagger Your tests passed on CircleCI!
Details
ci/circleci: check-docs Your tests passed on CircleCI!
Details
ci/circleci: validate-docs Your tests passed on CircleCI!
Details
docs Click details to preview the HTML documentation.
Details
swagger Click to preview the swagger build.
Details

@turt2live turt2live moved this from In progress to Done in Matrix 1.0 workflow Jun 4, 2019

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.