From 30b50052668fd13f0fcfaed6d73a4075a8fafc2c Mon Sep 17 00:00:00 2001 From: Richard van der Hoff Date: Fri, 13 Oct 2017 02:17:40 +0100 Subject: [PATCH] formatting --- README.rst | 97 ++++++++++++++++++++++++++++++------------------------ 1 file changed, 54 insertions(+), 43 deletions(-) diff --git a/README.rst b/README.rst index 4469702ac..83309a6a0 100644 --- a/README.rst +++ b/README.rst @@ -14,76 +14,87 @@ in `GitHub `_. The following labels are used to help categorize issues: `spec-omission `_ - Things which have been implemented but not currently specified. These may - range from entire API endpoints, to particular options or return - parameters. +-------------------------------------------------------------------------------- - Issues with this label will have been implemented in `Synapse - `_. Normally there will be a design - document in Google Docs or similar which describes the feature. +Things which have been implemented but not currently specified. These may range +from entire API endpoints, to particular options or return parameters. - Examples: +Issues with this label will have been implemented in `Synapse +`_. Normally there will be a design +document in Google Docs or similar which describes the feature. - * `Spec PUT /directory/list `_ - * `Unspec'd server_name request param for /join/{roomIdOrAlias} - `_ +Examples: + +* `Spec PUT /directory/list `_ +* `Unspec'd server_name request param for /join/{roomIdOrAlias} + `_ `clarification `_ - An area where the spec could do with being more explicit. +-------------------------------------------------------------------------------- + +An area where the spec could do with being more explicit. - Examples: +Examples: - * `Spec the implicit limit on /syncs - `_ +* `Spec the implicit limit on /syncs + `_ - * `Clarify the meaning of the currently_active flags in presence events - `_ + * `Clarify the meaning of the currently_active flags in presence events + `_ `bug `_ - Something which is in the spec, but is wrong. +------------------------------------------------------------ + +Something which is in the spec, but is wrong. - Note: this is *not* for things that are badly designed or don't work well - (for which see 'improvement' or 'feature') - it is for places where the - spec doesn't match reality. +Note: this is *not* for things that are badly designed or don't work well +(for which see 'improvement' or 'feature') - it is for places where the +spec doesn't match reality. - Examples: +Examples: - * `swagger is wrong for directory PUT - `_ +* `swagger is wrong for directory PUT + `_ - * `receipts section still refers to initialSync - `_ +* `receipts section still refers to initialSync + `_ `improvement `_ - A suggestion for a relaatively simple improvement to the protocol. +---------------------------------------------------------------------------- - Examples: +A suggestion for a relaatively simple improvement to the protocol. - * `We need a 'remove 3PID' API so that users can remove mappings - `_ - * `We should mandate that /publicRooms requires an access_token - `_ +Examples: + +* `We need a 'remove 3PID' API so that users can remove mappings + `_ +* `We should mandate that /publicRooms requires an access_token + `_ `feature `_ - A suggestion for a significant extension to the matrix protocol which - needs considerable consideration before implementation. +-------------------------------------------------------------------- + +A suggestion for a significant extension to the matrix protocol which +needs considerable consideration before implementation. - Examples: +Examples: - * `Peer-to-peer Matrix `_ - * `Specify a means for clients to "edit" previous messages - `_ +* `Peer-to-peer Matrix `_ +* `Specify a means for clients to "edit" previous messages + `_ `projects `_ - A project which needs adding to the 'Try Matrix Now' page. +---------------------------------------------------------------------- + +A project which needs adding to the 'Try Matrix Now' page. - Examples: +Examples: - * `add https://gitlab.com/uhoreg/matrix-appservice-prosody - `_ +* `add https://gitlab.com/uhoreg/matrix-appservice-prosody + `_ - * `add https://github.com/tavoda/matrix-java project - `_ +* `add https://github.com/tavoda/matrix-java project + `_ Structure of this repository ============================