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

Update the room tagging documentation #1606

Merged
merged 3 commits into from Aug 31, 2018

Conversation

3 participants
@turt2live
Member

turt2live commented Aug 29, 2018

Rendered: see 'docs' status check

Includes changes provided by @KitsuneRal (thank you!)


Fixes #1565

  • Document the actual tag structure
  • Clarify the examples use floats (this is also now represented by the example tag using a float)
  • Fix other misc spec things (id -> ID, 'MUST NOT', indentation, etc)

KitsuneRal and others added some commits Aug 26, 2018

Elaborate the structure of m.tag events
...and corresponding structures in tag-related CS API calls

Signed-off-by: Alexey Rusakov <Alexey.Rusakov@pm.me>

@turt2live turt2live requested a review from matrix-org/spec-core-team Aug 29, 2018

@turt2live turt2live added this to In review (just the PRs) in August 2018 r0 via automation Aug 29, 2018

@@ -39,7 +39,7 @@ with an ``order`` of ``0.2`` would be displayed before a room with an ``order``
of ``0.7``. If a room has a tag without an ``order`` key then it should appear
after the rooms with that tag that have an ``order`` key.
The name of a tag MUST not exceed 255 bytes.
The name of a tag MUST NOT exceed 255 bytes.

This comment has been minimized.

@richvdh

richvdh Aug 31, 2018

Member

ugh, this needs a better grammar :-S

This comment has been minimized.

@richvdh

richvdh Aug 31, 2018

Member

(raised as #1639)

August 2018 r0 automation moved this from In review (just the PRs) to Reviewer approved Aug 31, 2018

@turt2live turt2live merged commit afa16f1 into matrix-org:master Aug 31, 2018

7 checks passed

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

August 2018 r0 automation moved this from Reviewer approved to Done (this list will be incomplete) Aug 31, 2018

@turt2live turt2live deleted the turt2live:travis/c2s/room-tags branch Aug 31, 2018

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment