Skip to content

Improve README#40

Open
adamchainz wants to merge 1 commit into
koleror:masterfrom
adamchainz:improve_docs
Open

Improve README#40
adamchainz wants to merge 1 commit into
koleror:masterfrom
adamchainz:improve_docs

Conversation

@adamchainz

Copy link
Copy Markdown
  1. Fix some reStructuredText syntax
  2. Add syntax highlighting to code blocks.
  3. Make example code follow Black style, with double quotes, and simple indentation.
  4. Tweak some language, e.g. remove "simply" which can be read as dismissive "it's so simple".

I think these changes make the README a little more readable.

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.

1 participant