Hacker Newssmartfunc: Turn Docstrings into LLM-Functions
https://github.com/koaning/smartfunc
#HackerNews #smartfunc #LLMfunctions #docstrings #AItools #programming
C.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
(╯°□°）╯︵(\ .o.)\Kinda interesting tidbit: #chatgpt just introduced spelling errors into #docstrings I asked it to generate.
Pito Salas#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/)
Document Your Python Code and Projects With ChatGPT – Real Python
Good documentation is a critical feature of any successful Python project. In practice, writing documentation is hard and can take a lot of time and effort. Nowadays, with tools like ChatGPT, you can quickly document your Python code and projects.
Habr[Перевод] Создаём безукоризненную автодокументацию кода на 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
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.
Alexandre B A Villares 🐍#Python question:
How do you talk about \n chars in #docstrings? do you r""" the docstring?
Do you spell out "new line char"?
How do you talk about \n chars in #docstrings? do you r""" the docstring?
Do you spell out "new line char"?
Ariel RichtmanAnyone know a #FOSS #YAML library for generating documentation? I'm looking to do #DocStrings in #GitLab #CICD files. I've seen a handful of options but they seem abandoned or very nascent.
Paolo Melchiorre🌠 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
GitHub - pauloxnet/adventofcode: Pure Python solutions for the Advent of Code puzzles written by Paolo Melchiorre.
Pure Python solutions for the Advent of Code puzzles written by Paolo Melchiorre. - GitHub - pauloxnet/adventofcode: Pure Python solutions for the Advent of Code puzzles written by Paolo Melchiorre.