Fixes to the formatting of README.rst
#12627
Conversation
Fixes a couple of formatting errors which were introduced in #12475.
| @@ -55,7 +55,7 @@ solutions. The hope is for Matrix to act as the building blocks for a new | |||
| generation of fully open and interoperable messaging and VoIP apps for the | |||
| internet. | |||
|
|
|||
| Synapse is a Matrix "homeserver" implementation developed by the matrix.org core | |||
There was a problem hiding this comment.
Thanks. I need to figure out how to configure PyCharm to not do this when it automatically wraps a line.
There was a problem hiding this comment.
I don't think this trailing space was your doing, tbh, and it's not exactly the end of the world anyway. But my editor likes to strip them...
| @@ -294,13 +294,13 @@ directory of your choice:: | |||
| cd synapse | |||
|
|
|||
| Synapse has a number of external dependencies. We maintain a fixed development | |||
| environment using [poetry](https://python-poetry.org/). First, install poetry. We recommend | |||
| environment using `Poetry <https://python-poetry.org/>`_. First, install poetry. We recommend:: | |||
There was a problem hiding this comment.
Arg. Is there a ReST linter that might have caught this? Maybe https://pypi.org/project/restructuredtext-lint/
There was a problem hiding this comment.
FWIW, my training/tradition is to treat displayed items as a noun in the flow of a sentence, including punctuation if ending the sentence. Though this doesn't work brilliantly for source code.
There was a problem hiding this comment.
Arg. Is there a ReST linter that might have caught this? Maybe https://pypi.org/project/restructuredtext-lint/
I've never looked into this, tbh. Given the README is the only RST thing we have nowadays, I'm not sure it's worth much linting effort, though I'll not statnd in the way.
There was a problem hiding this comment.
FWIW, my training/tradition is to treat displayed items as a noun in the flow of a sentence, including punctuation if ending the sentence. Though this doesn't work brilliantly for source code.
Afraid I'm not really sure what you're referring to here. The capitalisation of "Poetry"? The :: ?
There was a problem hiding this comment.
I've never looked into this, tbh. Given the README is the only RST thing we have nowadays, I'm not sure it's worth much linting effort, though I'll not statnd in the way.
Further, it's not obvious what there is to "catch": it was valid RST, it just didn't do what you wanted it to do. markdown-style links are a common error that we could look for explicitly, I suppose, but I'm not sure it's reasonable to expect any generic RST linter to do so.
There was a problem hiding this comment.
FWIW, my training/tradition is to treat displayed items as a noun in the flow of a sentence, including punctuation if ending the sentence. Though this doesn't work brilliantly for source code.
Afraid I'm not really sure what you're referring to here. The capitalisation of "Poetry"? The
::?
Sorry. I meant the omission of the trailing ::. The intent was that the following is all one sentence:
We recommend
<block of shell>, as described here.
But that's a mionr style thing that isn't worth squabbling over.
There was a problem hiding this comment.
I want a program that knows all of the mistakes that I make in advance and catches them. AKA, the moon on a stick.
There was a problem hiding this comment.
Sorry. I meant the omission of the trailing
::. The intent was that the following is all one sentence:
Oh right. :: in RST has special syntactic meaning (https://docutils.sourceforge.io/docs/user/rst/quickref.html#literal-blocks). Not sure if there is a way to get that effect without also getting a : in the output.
There was a problem hiding this comment.
Not sure if there is a way to get that effect without also getting a
:in the output.
apparently you stick the :: on a line on its own. TIL.
Synapse 1.59.0rc1 (2022-05-10) ============================== This release makes several changes that server administrators should be aware of: - Device name lookup over federation is now disabled by default. ([\#12616](#12616)) - The `synapse.app.appservice` and `synapse.app.user_dir` worker application types are now deprecated. ([\#12452](#12452), [\#12654](#12654)) See [the upgrade notes](https://github.com/matrix-org/synapse/blob/develop/docs/upgrade.md#upgrading-to-v1590) for more details. Additionally, this release removes the non-standard `m.login.jwt` login type from Synapse. It can be replaced with `org.matrix.login.jwt` for identical behaviour. This is only used if `jwt_config.enabled` is set to `true` in the configuration. ([\#12597](#12597)) Features -------- - Support [MSC3266](matrix-org/matrix-spec-proposals#3266) room summaries over federation. ([\#11507](#11507)) - Implement [changes](matrix-org/matrix-spec-proposals@4a77139) to [MSC2285 (hidden read receipts)](matrix-org/matrix-spec-proposals#2285). Contributed by @SimonBrandner. ([\#12168](#12168), [\#12635](#12635), [\#12636](#12636), [\#12670](#12670)) - Extend the [module API](https://github.com/matrix-org/synapse/blob/release-v1.59/synapse/module_api/__init__.py) to allow modules to change actions for existing push rules of local users. ([\#12406](#12406)) - Add the `notify_appservices_from_worker` configuration option (superseding `notify_appservices`) to allow a generic worker to be designated as the worker to send traffic to Application Services. ([\#12452](#12452)) - Add the `update_user_directory_from_worker` configuration option (superseding `update_user_directory`) to allow a generic worker to be designated as the worker to update the user directory. ([\#12654](#12654)) - Add new `enable_registration_token_3pid_bypass` configuration option to allow registrations via token as an alternative to verifying a 3pid. ([\#12526](#12526)) - Implement [MSC3786](matrix-org/matrix-spec-proposals#3786): Add a default push rule to ignore `m.room.server_acl` events. ([\#12601](#12601)) - Add new `mau_appservice_trial_days` configuration option to specify a different trial period for users registered via an appservice. ([\#12619](#12619)) Bugfixes -------- - Fix a bug introduced in Synapse 1.48.0 where the latest thread reply provided failed to include the proper bundled aggregations. ([\#12273](#12273)) - Fix a bug introduced in Synapse 1.22.0 where attempting to send a large amount of read receipts to an application service all at once would result in duplicate content and abnormally high memory usage. Contributed by Brad & Nick @ Beeper. ([\#12544](#12544)) - Fix a bug introduced in Synapse 1.57.0 which could cause `Failed to calculate hosts in room` errors to be logged for outbound federation. ([\#12570](#12570)) - Fix a long-standing bug where status codes would almost always get logged as `200!`, irrespective of the actual status code, when clients disconnect before a request has finished processing. ([\#12580](#12580)) - Fix race when persisting an event and deleting a room that could lead to outbound federation breaking. ([\#12594](#12594)) - Fix a bug introduced in Synapse 1.53.0 where bundled aggregations for annotations/edits were incorrectly calculated. ([\#12633](#12633)) - Fix a long-standing bug where rooms containing power levels with string values could not be upgraded. ([\#12657](#12657)) - Prevent memory leak from reoccurring when presence is disabled. ([\#12656](#12656)) Updates to the Docker image --------------------------- - Explicitly opt-in to using [BuildKit-specific features](https://github.com/moby/buildkit/blob/master/frontend/dockerfile/docs/syntax.md) in the Dockerfile. This fixes issues with building images in some GitLab CI environments. ([\#12541](#12541)) - Update the "Build docker images" GitHub Actions workflow to use `docker/metadata-action` to generate docker image tags, instead of a custom shell script. Contributed by @henryclw. ([\#12573](#12573)) Improved Documentation ---------------------- - Update SQL statements and replace use of old table `user_stats_historical` in docs for Synapse Admins. ([\#12536](#12536)) - Add missing linebreak to `pipx` install instructions. ([\#12579](#12579)) - Add information about the TCP replication module to docs. ([\#12621](#12621)) - Fixes to the formatting of `README.rst`. ([\#12627](#12627)) - Fix docs on how to run specific Complement tests using the `complement.sh` test runner. ([\#12664](#12664)) Deprecations and Removals ------------------------- - Remove unstable identifiers from [MSC3069](matrix-org/matrix-spec-proposals#3069). ([\#12596](#12596)) - Remove the unspecified `m.login.jwt` login type and the unstable `uk.half-shot.msc2778.login.application_service` from [MSC2778](matrix-org/matrix-spec-proposals#2778). ([\#12597](#12597)) - Synapse now requires at least Python 3.7.1 (up from 3.7.0), for compatibility with the latest Twisted trunk. ([\#12613](#12613)) Internal Changes ---------------- - Use supervisord to supervise Postgres and Caddy in the Complement image to reduce restart time. ([\#12480](#12480)) - Immediately retry any requests that have backed off when a server comes back online. ([\#12500](#12500)) - Use `make_awaitable` instead of `defer.succeed` for return values of mocks in tests. ([\#12505](#12505)) - Consistently check if an object is a `frozendict`. ([\#12564](#12564)) - Protect module callbacks with read semantics against cancellation. ([\#12568](#12568)) - Improve comments and error messages around access tokens. ([\#12577](#12577)) - Improve docstrings for the receipts store. ([\#12581](#12581)) - Use constants for read-receipts in tests. ([\#12582](#12582)) - Log status code of cancelled requests as 499 and avoid logging stack traces for them. ([\#12587](#12587), [\#12663](#12663)) - Remove special-case for `twisted` logger from default log config. ([\#12589](#12589)) - Use `getClientAddress` instead of the deprecated `getClientIP`. ([\#12599](#12599)) - Add link to documentation in Grafana Dashboard. ([\#12602](#12602)) - Reduce log spam when running multiple event persisters. ([\#12610](#12610)) - Add extra debug logging to federation sender. ([\#12614](#12614)) - Prevent remote homeservers from requesting local user device names by default. ([\#12616](#12616)) - Add a consistency check on events which we read from the database. ([\#12620](#12620)) - Remove use of the `constantly` library and switch to enums for `EventRedactBehaviour`. Contributed by @andrewdoh. ([\#12624](#12624)) - Remove unused code related to receipts. ([\#12632](#12632)) - Minor improvements to the scripts for running Synapse in worker mode under Complement. ([\#12637](#12637)) - Move `pympler` back in to the `all` extras. ([\#12652](#12652)) - Fix spelling of `M_UNRECOGNIZED` in comments. ([\#12665](#12665)) - Release script: confirm the commit to be tagged before tagging. ([\#12556](#12556)) - Fix a typo in the announcement text generated by the Synapse release development script. ([\#12612](#12612)) - Fix scripts-dev to pass typechecking. ([\#12356](#12356)) - Add some type hints to datastore. ([\#12485](#12485)) - Remove unused `# type: ignore`s. ([\#12531](#12531)) - Allow unused `# type: ignore` comments in bleeding edge CI jobs. ([\#12576](#12576)) - Remove redundant lines of config from `mypy.ini`. ([\#12608](#12608)) - Update to mypy 0.950. ([\#12650](#12650)) - Use `Concatenate` to better annotate `_do_execute`. ([\#12666](#12666)) - Use `ParamSpec` to refine type hints. ([\#12667](#12667)) - Fix mypy against latest pillow stubs. ([\#12671](#12671))
Fixes a couple of formatting errors which were introduced in #12475.