Closed joshmoore closed 4 years ago
Main downside of this approach that the generated Sphinx API docs does not seem to unescape the [
The only other alternative to this proposal I found of would be to generate raw docstrings which should handle backslahes - see the last paragraph of https://www.python.org/dev/peps/pep-0257/#what-is-a-docstring. I have not looked into whether this is something that can be achieved without great efforts either in slice2py
and/or in some post-processing step.
Odd. In my testing, barring the r"""
, the lbrack
was the only thing that was properly rendered.
Latest seems to be fine without this. Closing.
In Python 3, the doc strings of Python modules are unicode and the initial slash is interpreted as an invalid escape sequence:
see also: https://github.com/ome/omero-blitz/commit/64222ab24