diff options
author | Marius Gedminas <marius@gedmin.as> | 2018-12-07 17:41:45 +0200 |
---|---|---|
committer | Ian Stapleton Cordasco <graffatcolmingov@gmail.com> | 2018-12-07 09:41:45 -0600 |
commit | e5db06d9a8c6d613783997ac44621a7b86603f35 (patch) | |
tree | 685c449c39e22e2126f7b75864c51c84d0997e39 /README.rst | |
parent | 7d4476e1fde8876c3bc145d066188ecdc14c6526 (diff) | |
download | pyflakes-e5db06d9a8c6d613783997ac44621a7b86603f35.tar.gz |
Rename NEWS.txt to NEWS.md for nicer rendering (#394)
* Rename NEWS.txt to NEWS.md for nicer rendering
Make the changelog render more nicely on GitHub by using a markup
language.
I've decided that Markdown is closer to the existing format due to the
use of single backticks for preformatted text.
* Convert NEWS to ReStructuredText
As requested.
ReST is picky so I had to make the following changes:
- change `backticks` to ``preformatted text`
- escape one stray * as \* so it doesn't turn on italic
- de-dent item lists to they're not wrapped in a <blockquote>
- insert blank lines between version subheadings and unordered lists
Diffstat (limited to 'README.rst')
-rw-r--r-- | README.rst | 2 |
1 files changed, 1 insertions, 1 deletions
@@ -86,4 +86,4 @@ All changes should include tests and pass flake8_. Changelog --------- -Please see `NEWS.txt <NEWS.txt>`_. +Please see `NEWS.rst <NEWS.rst>`_. |