Convert the README to use Markdown rather than reStructuredText for consistency and familiarity. #278
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Olivier Wilkinson (reivilibre) <[email protected]>
reivilibre
changed the title
Both synapse and sydent seem to use rST? |
clokep
reviewed
Nov 29, 2021
Gah. I don't know what planet I was on imagining that they don't... |
DMRobertson
approved these changes
Nov 30, 2021
There was a problem hiding this comment.
I have no strong opinions on Markdown versus RST, but this looks like a sensible conversion from one to the other.
(For completeness, I had a good experience with Sphinx + autodoc + doctest + intersphinx + viewcode, so have some lingering positive emotions attributed to RST)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I personally get tripped up by rST's not-quite-Markdown false friends and I also reckon that Markdown is more widely-known.
Rendered: https://github.com/matrix-org/sygnal/blob/05b2202efae4ae02994a65cc96910b66734c1898/README.md