Skip to content

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

Merged
jplatte merged 1 commit into
matrix-org:mainfrom
enterprisey:main
Feb 13, 2023
Merged

jplatte merged 1 commit into
matrix-org:mainfrom
enterprisey:main

Conversation

@enterprisey

Copy link
Copy Markdown
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

zecakeh commented Feb 13, 2023

Copy link
Copy Markdown
Collaborator

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.

@jplatte jplatte left a comment

Copy link
Copy Markdown
Collaborator

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

jplatte commented Feb 13, 2023

Copy link
Copy Markdown
Collaborator

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