To be fair, I think it would.
def blah(escape_code: str) -> str:
'''The only escape code `blah()` currently supports is '\e'.'''
return escape_code
Currently, if you hover over blah()
in vscode, this will render as The only escape code blah() currently supports is '\e'.
, however, if \e
was added as an escape code, it could end up rendering as The only escape code blah() currently supports is ' '.
. Why? Because if you change the docstring to The only escape code blah() currently supports is '\n'.
vscode will render it as The only escape code blah() currently supports is ' '.
.
Personally, >90% of my time spent reading docstrings is spent reading docstrings via vscode.
I think you’d probably have the same problem with other applications that render docstrings.