robotools / vanilla

A Pythonic wrapper around Cocoa.
MIT License
78 stars 28 forks source link

Wrong quotes in sphinx documentation #171

Open arialcrime opened 2 years ago

arialcrime commented 2 years ago

Even though the correct kind of (straight) quotes are used in the docstrings, the rendered documentation changes them to “typographic” ones. This makes copying from the documentation a bit more tedious than it has to be.

justvanrossum commented 2 years ago

Perhaps backticks should be used in the doc string:

*`"should close"`*
arialcrime commented 2 years ago

That sounds extensive. Maybe explicitly setting this to False already solves it? https://github.com/robotools/vanilla/blob/873d9832da66fc085591beea4f04c998b4dd04c1/Documentation/source/conf.py#L130-L132

justvanrossum commented 2 years ago

Generally we need to mark code fragments as "code", and I would say the smarty pants behavior is desirable for non-code.