Skip to content

Attempt to improve readability of error codes sections#2323

Merged
richvdh merged 2 commits intomatrix-org:mainfrom
hughns:hughns/error-codes-layout
Mar 3, 2026
Merged

Attempt to improve readability of error codes sections#2323
richvdh merged 2 commits intomatrix-org:mainfrom
hughns:hughns/error-codes-layout

Conversation

@hughns
Copy link
Copy Markdown
Member

@hughns hughns commented Feb 27, 2026

The idea for this came from #2315 (comment)

If this looks like a sensible direction then I can tidy up the PR for full review.

Before vs After:
image

Pull Request Checklist

Preview: https://pr2323--matrix-spec-previews.netlify.app

@hughns hughns marked this pull request as ready for review February 27, 2026 11:10
@hughns hughns requested a review from a team as a code owner February 27, 2026 11:10
@richvdh richvdh self-requested a review February 27, 2026 13:09
Copy link
Copy Markdown
Member

@richvdh richvdh left a comment

Choose a reason for hiding this comment

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

Looks great, thanks!

@richvdh richvdh merged commit c9face5 into matrix-org:main Mar 3, 2026
13 checks passed
@richvdh
Copy link
Copy Markdown
Member

richvdh commented Mar 3, 2026

If this looks like a sensible direction then I can tidy up the PR for full review.

Oh, I missed this bit. It looked fine?

@hughns
Copy link
Copy Markdown
Member Author

hughns commented Mar 4, 2026

If this looks like a sensible direction then I can tidy up the PR for full review.

Oh, I missed this bit. It looked fine?

I think I wanted to check if the indentation style was important. In the other places where definition lists are used it has multiple spaces after the ::

Push Provider
: A push provider is a service managed by the device vendor which can send
notifications directly to the device. Google Cloud Messaging (GCM) and
Apple Push Notification Service (APNS) are two examples of push
providers.
Push Gateway
: A push gateway is a server that receives HTTP event notifications from
homeservers and passes them on to a different protocol such as APNS for
iOS devices or GCM for Android devices. Clients inform the homeserver
which Push Gateway to send notifications to when it sets up a Pusher.
Pusher
: A pusher is a worker on the homeserver that manages the sending of HTTP
notifications for a user. A user can have multiple pushers: one per
device.
Push Rule
: A push rule is a single rule that states under what *conditions* an
event should be passed onto a push gateway and *how* the notification
should be presented. These rules are stored on the user's homeserver.
They are manually configured by the user, who can create and view them
via the Client/Server API.
Push Ruleset
: A push ruleset *scopes a set of rules according to some criteria*. For
example, some rules may only be applied for messages from a particular
sender, a particular room, or by default. The push ruleset contains the
entire set of rules.

If the is tidying to do then can definitely happen in another PR 👍

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.

2 participants