diff options
| author | Chris Jerdonek <chris.jerdonek@gmail.com> | 2012-09-22 20:00:46 -0700 |
|---|---|---|
| committer | Chris Jerdonek <chris.jerdonek@gmail.com> | 2012-09-22 20:00:46 -0700 |
| commit | eb483b087b66077e23d664717d00c8005eedf38f (patch) | |
| tree | 73146fbc2feb10abb7ed42206908422c5e64090a /README.md | |
| parent | 5db89b1df20ecaebf332b7ece3cc5bcddd945652 (diff) | |
| download | pystache-eb483b087b66077e23d664717d00c8005eedf38f.tar.gz | |
Improve README.md comment re: HTML in reST long description.
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 8 |
1 files changed, 6 insertions, 2 deletions
@@ -1,8 +1,12 @@ Pystache ======== -<!-- We strip out 1-line HTML comments prior to passing to pandoc because --> -<!-- PyPI rejects reST long descriptions that contain HTML. --> +<!-- Since PyPI rejects reST long descriptions that contain HTML, --> +<!-- HTML comments must be removed when converting this file to reST. --> +<!-- For more information on PyPI's behavior in this regard, see: --> +<!-- http://docs.python.org/distutils/uploading.html#pypi-package-display --> +<!-- The Pystache setup script strips 1-line HTML comments prior --> +<!-- to converting to reST, so all HTML comments should be one line. --> <!-- We leave the leading brackets empty here. Otherwise, unwanted --> <!-- caption text shows up in the reST version converted by pandoc. --> |