Python Rennes<p>saviez-vous qu'il était possible de référencer des images avec la syntaxe <a href="https://social.breizhcamp.org/tags/markdown" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>markdown</span></a> dans la <a href="https://social.breizhcamp.org/tags/docstring" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>docstring</span></a> de code <a href="https://social.breizhcamp.org/tags/Python" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>Python</span></a> ?<br><a href="https://mathspp.com/blog/til/images-in-docstrings" rel="nofollow noopener" translate="no" target="_blank"><span class="invisible">https://</span><span class="ellipsis">mathspp.com/blog/til/images-in</span><span class="invisible">-docstrings</span></a></p><p>Vous pouvez ainsi pointer vers des diagrammes, qui apparaîtront dans l'infobulle que vos IDE (<a href="https://social.breizhcamp.org/tags/codium" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>codium</span></a> / <a href="https://social.breizhcamp.org/tags/vsCode" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>vsCode</span></a> par exemple) affichent au survol de la fonction, méthode ou classe concernée.</p>
#docstring
0 posts0 participants0 posts today
Peter 
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…
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) .
#xdoctest: A rewrite of #Python's builtin doctest module (with #pytest plugin integration) but without all the weirdness | #dev #docstring #tests https://github.com/Erotemic/xdoctest
github.comErotemic/xdoctestA rewrite of Python's builtin doctest module (with pytest plugin integration) but without all the weirdness - Erotemic/xdoctest
#darglint: A #python documentation linter which checks that the #docstring description matches the definition. | #dev #implementation #match https://github.com/terrencepreilly/darglint
GitHubGitHub - terrencepreilly/darglint: A python documentation linter which checks that the docstring description matches the definition.A python documentation linter which checks that the docstring description matches the definition. - GitHub - terrencepreilly/darglint: A python documentation linter which checks that the docstring ...