[issue28710] Sphinx incompatible markup in the standard library docstrings

Terry J. Reedy added the comment: I agree with David. I would like the ugly markup changed independent of how Sphinx treats it. I was thinking of changing the title to "Change obsolete tex markup in stdlib docstrings". The intent of `word' was for people to see balanced quotes, which in a

[issue28710] Sphinx incompatible markup in the standard library docstrings

R. David Murray added the comment: I would still like to see the legacy tex markup removed from the docstrings, so I think closing this issue is not appropriate, but it's not a big enough deal that I'll push for it if Raymond wants to keep it closed. -- _

[issue28710] Sphinx incompatible markup in the standard library docstrings

Raymond Hettinger added the comment: Marking this as closed. Though well-intentioned, the suggestion is predicated on a misperception of the role of Sphinx for CPython and existing PEP recommendations on docstring practices. -- nosy: +rhettinger resolution: -> not a bug stage: patc

[issue28710] Sphinx incompatible markup in the standard library docstrings

Terry J. Reedy added the comment: RestructuredText, DocUtils, and Sphinx were developed independently, by people other than the pydev/cpython group. (The proposal to include DocUtils in the stdlib was rejected.) We converted to .rst for the Python documentation sources files about a decade

[issue28710] Sphinx incompatible markup in the standard library docstrings

Patrick Lehmann added the comment: Having single quotes in docstrings is also ok for Sphinx documentation. Btw. ReStructured text (docutils) was invented to document Python sources, why is it not used by Python? -- ___ Python tracker

[issue28710] Sphinx incompatible markup in the standard library docstrings

Serhiy Storchaka added the comment: Oh, you are right. I didn't write much English TeX, and used other types of quotes. I'm sure that I seen `such quotation' in non-TeX files, but maybe my memory fools me. In any case using this writing here is likely an artifact of copying from a TeX docum

[issue28710] Sphinx incompatible markup in the standard library docstrings

Terry J. Reedy added the comment: > AFAIK `name' is common writing of quotes in English texts I don't remember ever seeing it before. It looks like a typo to me, and I am sure it will to most readers. I think it should be corrected as if it were a typo. -- ___

[issue28710] Sphinx incompatible markup in the standard library docstrings

R. David Murray added the comment: No, it is (somewhat) unique to tex. If you write `word' tex would turn that into a pair of opposing quotes in the typeset document, as opposed to 'word' (the convention in regular text/emails/posts/etc) where you'd just see ascii quotes. tex would render

[issue28710] Sphinx incompatible markup in the standard library docstrings

Serhiy Storchaka added the comment: What is the problem? Docstrings are not written in the reStructuredText format in general. If Sphinx complains about docstrings in the stlib, don't run Sphinx for the stdlib files or report a Sphinx bug. Even if remove all `x', docstrings still will not be

[issue28710] Sphinx incompatible markup in the standard library docstrings

R. David Murray added the comment: By the way, in case anyone is curious, I'm pretty sure that markup is left over from the days when tex/latex was what docs were *written* in. -- ___ Python tracker ___

[issue28710] Sphinx incompatible markup in the standard library docstrings

R. David Murray added the comment: Right, my opinion is that we shouldn't be putting markup in docstrings. They are (from our point of view) pure text. I don't know if discussion on python-dev is warranted, it seems like a fairly uncontroversial change, since it brings the docstrings in que

[issue28710] Sphinx incompatible markup in the standard library docstrings

Change by Raymond Hettinger : -- title: Sphinx incompatible markup in the standard library -> Sphinx incompatible markup in the standard library docstrings ___ Python tracker