#docstring

2025-02-02

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!

github.com/multimeric/DocStran

#python #docstring

2025-01-07

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

Elod Pal Csirmazcsirmaz@fosstodon.org
2024-12-01

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!

2024-04-13

I guess I should spend some time learning Phoenix.

#docstring #python

2024-04-13

I guess I should spend some time learning Phoenix.

#docstring #python

2024-03-20

Someone made a Visual Studio Code extension to highlight docstrings in python ! I needed this soo much :pleading_face_3d:

github.com/rodolphebarbanneau/

#vscode #code #dev #editor #ide #extensions #python #docstring

🇺🇸 Peter 🇳🇱petervanderdoes@mas.to
2024-01-24

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

2023-11-09

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?

#programming #documentation #DevTools #PyCharm

A screenshot showing a portion of the PyCharm integrated development environment settings menu where you a choice could be made for the docstring format used. Options shown are: Plain, Epytext, reStructuredText, Numpy and Google.
2023-10-14

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.

2023-07-27

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…

『 บูเบ๋อ 』bluebirz@miraiverse.xyz
2023-07-26
#bluebirzblog
Well-documented with variable #type_annotation & #Docstring
This blog we're gonna discuss about 2 simple stuff we can improve our source code to become a good self-explained source code.
[EN] https://www.bluebirz.net/en/type-annotation-docstring/
[TH] https://www.bluebirz.net/th/type-annotation-docstring-th/
[Medium] https://medium.com/@bluebirz/well-documented-with-variable-type-annotation-docstring-735a76f77228
spaceotter :mastodon: 🏳️‍🌈spaceotter@mastodon.online
2023-01-11

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) .

#docstring #foss #emacs29 #linux #programming #lisp

Client Info

Server: https://mastodon.social
Version: 2025.04
Repository: https://github.com/cyevgeniy/lmst