Message280907
Why does e.g. configparser.ConfigParser contain doc strings with Sphinx incompatible markup?
The markup starts with back-tick, but ends with a single quote.
Example:
https://github.com/python/cpython/blob/master/Lib/configparser.py?ts=2#L26
Sphinx writes these messages:
D:\git\PoC\py\lib\ExtendedConfigParser\__init__.py:docstring of lib.ExtendedConfigParser.ExtendedConfigParser.read_file:3: WARNING: Inline interpreted text or phrase reference start-str
ing without end-string.
Note: ExtendedConfigParser is class derived from configparser.ConfigParser. Inherited methods get documented too.
------------------------
Btw. I have some improvements for this class, how can I contribute them? Who is the maintainer for this class? Please contact me: Patrick.Lehmann@tu-dresden.de
The improved version is available at GitHub: https://github.com/Paebbels/ExtendedConfigParser?ts=2 |
|
Date |
User |
Action |
Args |
2016-11-16 00:59:42 | Patrick Lehmann | set | recipients:
+ Patrick Lehmann, docs@python |
2016-11-16 00:59:42 | Patrick Lehmann | set | messageid: <1479257982.94.0.253343336813.issue28710@psf.upfronthosting.co.za> |
2016-11-16 00:59:42 | Patrick Lehmann | link | issue28710 messages |
2016-11-16 00:59:42 | Patrick Lehmann | create | |
|