Another new library release: DocStrands lets you re-use segments of your docstrings between functions.
Copy-pasting docstrings has long frustrated me, so I came up with my own solution!
Another new library release: DocStrands lets you re-use segments of your docstrings between functions.
Copy-pasting docstrings has long frustrated me, so I came up with my own solution!
First day in office after the holiday break and I start off with a #refactor of the scripts that cost me quite some nerves in December. #docstring #blackcode
With #Python now being "the most popular programming language" (don't get me started...), the #Unicode consortium has announced a new #codepoint specifically to aid Python #developers and increase efficiency -- both of time, and of storage.
The next Unicode release will include a codepoint representing triple double quotes, making #docstrings much easier.
#quotes #DoubleQuotes #TripleDoubleQuotes #docstring #syntax #popularity
Hi I have a simple #python project on #github. What's the easiest way to convert #docstring s and type hints to something nice, like static #markdown or #html? I've been looking into #mkdocs, #mkdocstring, #sphinx and #readthedocs but they all seem a bit overkill. Or maybe if you know a great tutorial for one of these tools? Thanks!
I guess I should spend some time learning Phoenix.
#docstring #python
I guess I should spend some time learning Phoenix.
Someone made a Visual Studio Code extension to highlight docstrings in python ! I needed this soo much :pleading_face_3d:
https://github.com/rodolphebarbanneau/python-docstring-highlighter
#vscode #code #dev #editor #ide #extensions #python #docstring
Does anybody know how to document in #Python that the return value of a function is a #Django Queryset? And better if the queryset is of a specific model. #docstring
For a programming language (formerly) overseen by a benevolent dictator for life, #Python is awfully democratic.
Help me learn and decide: Which type of #docstring should I use in my Python code and why?
- Plain
- Epytext
- reStructuredText
- Numpy
- Google?
When #programming, the first thing I write for a new #python #class or #method is the #docstring. (Sorry about all the hashtags, but you did see this.)
Docstrings written this way are expressions of optimism and hope: What it says it does you will soon be able to make it do! It's happened enough times for me to really believe it now. Therein lies a directed, focused burst of creativity.
The alternative: grudging summary of a solution to a problem that might not have been very well defined.
I've been doing some VS Code extension hacking recently (something cool coming soon, possibly!) and I have to say...
It is really a testament to LISP and to the Emacs contributors that docstrings are:
1. a core part of the language
2. are available on nearly every function and command
The best way to even find out if a command _exists_ in VS Code is to open the "keyboard shortcuts" window. And then just guess the args…
#vscode #vscodeExtension #emacs #elisp #lisp #docstring #documentation
Been playing around with the new #treesitter feature in #emacs. Using it to add docstrings to the current function in #python (in the bottom right window) .
Python – Documenting Code
https://scitech.video/videos/watch/2ca8aaf9-5aa4-4b55-b4e2-1da5d7fb35b7