6 ms·
Having a cheat sheet around, or editor support helps. I'm not sure fragmenting doc string syntax further is a good idea for the python community. There's been
by illumen 11y ago
Having a cheat sheet around, or editor support helps.
I'm not sure fragmenting doc string syntax further is a good idea for the python community. There's been efforts to support Markdown on pypi for README.md. But even that has been met with a lot of resistance.
- zo1 11y agoI really don't understand this. Everyone wants to do it their way when it comes to docstrings. One of the big unfortunate culprits is "PyDev", which is an Eclipse plugin for python development. It's sole developer decided to divert from the already-established (if not already-hacky) docstring format of type hinting for lists. So now, instead of: "list of str", we have to contend with another format of: "list(str)". I can't wait for the python PEP standards for function-annotation to become standard and permeate the editors.