➜

This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

Author Patrick Lehmann
Recipients Patrick Lehmann, docs@python
Date 2016-11-16.00:59:42
SpamBayes Score -1.0
Marked as misclassified Yes
Message-id <1479257982.94.0.253343336813.issue28710@psf.upfronthosting.co.za>
In-reply-to
Content 
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
History
Date User Action Args
2016-11-16 00:59:42Patrick Lehmannsetrecipients: + Patrick Lehmann, docs@python
2016-11-16 00:59:42Patrick Lehmannsetmessageid: <1479257982.94.0.253343336813.issue28710@psf.upfronthosting.co.za>
2016-11-16 00:59:42Patrick Lehmannlinkissue28710 messages
2016-11-16 00:59:42Patrick Lehmanncreate