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

docs(sdk): Improve read receipt/marker explanation #1491

Merged
merged 1 commit into from
Feb 13, 2023

Conversation

enterprisey
Copy link
Contributor

It was unclear what the relationship between the read receipt and read marker was, so I copied a bit from https://spec.matrix.org/latest/client-server-api/#fully-read-markers and added hyperlinks between the functions.

Signed-off-by: Enterprisey apersonwiki@gmail.com

See private accepted DCO signoff at matrix-org/synapse#13818 (comment)

@zecakeh
Copy link
Collaborator

zecakeh commented Feb 13, 2023

Note that I'm actually planning on changing these methods to allow to use all the new possibilities of the spec introduced in Matrix 1.4, so the docs will probably change there too. I'll open a PR later today.

Copy link
Collaborator

@jplatte jplatte left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Future improvements aside, this looks good. Thanks!

@jplatte
Copy link
Collaborator

jplatte commented Feb 13, 2023

Oh, since #1490 isn't merged yet CI will fail but that's no problem, I'll take care of it.

@jplatte jplatte merged commit e45bf9f into matrix-org:main Feb 13, 2023
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.

3 participants