smartfunc: Turn Docstrings into LLM-Functions

https://github.com/koaning/smartfunc

#HackerNews #smartfunc #LLMfunctions #docstrings #AItools #programming

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

Kinda interesting tidbit: #chatgpt just introduced spelling errors into #docstrings I asked it to generate.

#python #documentation #docstrings #chat-gpt #tips #howto : "Document Your Python Code and Projects With ChatGPT – Real Python"(https://realpython.com/document-python-code-with-chatgpt/)

[Перевод] Создаём безукоризненную автодокументацию кода на Python с помощью Sphinx

В этой статье я расскажу о генераторе документации Sphinx , с помощью которого можно автоматически создавать документацию для модулей Python. Кроме того, я буду использовать шаблон проекта Cookiecutter Data Science в Visual Studio Code (VS Code), поскольку он легко интегрируется в Sphinx и имеет стандартизированную структуру директорий. Официальное пособие по использованию Sphinx — отличный ресурс для пользователей, которые хотят углубиться в детали. А моя статья — это краткое руководство по началу работы с этим инструментом.

https://habr.com/ru/companies/netologyru/articles/815563/

#python #документация #sphinx #data_science #автодокументация #docstrings #demopy #строки_документации #confpy #модули_python

@davidism

Depending on what you mean by attribute - you just want to extract the #docstrings?

On class (and class instances) and function/method objects, it's available as `<obj>.__doc__`. Same for modules. That covers most types of objects...

If you mean extracting information from type annotations, there's an inspection interface for that, too.

@folkerschamel @zenforyen @kevin @ado

Actually, I think that #type #hints in the #function #signature are usually *better* than having them in #docstrings. Not only can they not get out of date / become wrong (without causing checking failures), static type checking is much easier this way.

#Python question:
How do you talk about \n chars in #docstrings? do you r""" the docstring?
Do you spell out "new line char"?

🌠 I created a #GitHub repository with my #Python solutions for the #AdventOfCode puzzles

🧩 All solutions use only the #PythonStandardLibrary with no need for external packages

🔬 #Tests are included in function #docstrings and can be run using the #doctest module

⚠️ I don't think I will be able to enter the #solutions every day and definitely not in the morning

🐍 I participate in #AoC to #improve my Python #knowledge rather than to compete in the #leaderboard

👇
https://github.com/pauloxnet/adventofcode

@HeidiSeibold I try to document my software well. Keep documentation and code together. I believe this makes it less likely to get out of sync.
In #Python , #docstrings are great for usage documentation. They are embedded in the code and at the same time facilitate automatic generation of nicely formatted, coherent documentation.
I also try to improve code readability by opting for more self-explanatory code structures and naming and comment sparingly where necessary.