Публикации по теме 'docstring'
Строки документации Python
Строки документации Python (или строки документации) предоставляют удобный способ связывания документации с модулями, функциями, классами и методами Python.
Он указывается в исходном коде и используется, как комментарий, для документирования определенного сегмента кода. В отличие от обычных комментариев исходного кода, строка документации должна описывать, что делает функция, а не как.
Как должна выглядеть строка документации?
Строка документа должна начинаться с заглавной буквы и..
Вопросы по теме 'docstring'
Как распечатать Docstring функции python изнутри самой функции?
Я хочу распечатать строку документации функции python изнутри самой функции. для например.
def my_function(self):
"""Doc string for my function."""
# print the Docstring here.
На данный момент я делаю это сразу после определения...
78008 просмотров
schedule
23.09.2022
Просмотреть строки документации reStructuredText (Sphinx) в iPython?
Есть ли способ, чтобы IPython полностью отображал строки документации reStructuredText (для Sphinx), когда вы вводите следующее:
help foo
or:
foo?
Меня супер отвлекает попытка прочитать справочную документацию в IPython, когда она...
1402 просмотров
schedule
04.06.2023
Python IDE для автозаполнения строки документации
Я ищу Python IDE, который может автоматически генерировать для меня структуру docstrings. Например:
def GetTextByCtrlName(self, _hwnd, _ctrName):
'''
@desc:
@param:
_hwnd
_ctrName...
1814 просмотров
schedule
11.10.2023
Строка документации Clojure для библиотек/пространств имен
Как добавить строки документации и/или комментарии к библиотекам/пространствам имен Clojure в целом, то есть не только к конкретным функциям в пространстве имен?
Я заметил, что исходный код clojure использует для этого (comment ...) в некоторых...
3549 просмотров
schedule
29.12.2023
Какая разница в строках документации с тройными ОДИНАРНЫМИ кавычками и тройными ДВОЙНЫМИ кавычками?
Мне просто интересно, в чем разница между двумя способами написания строк документации Python ( __doc__ ):
три одинарных кавычки:
'''
Comment goes here
'''
три двойные кавычки:
"""
Comment goes here
"""
Есть ли тонкая...
10925 просмотров
schedule
16.07.2023
Как NumPy обрабатывает строки документации в документации sphinx для параметров?
Я хочу создать нашу документацию с помощью sphinx и получить такое же форматирование параметров, как и в документации NumPy ( https://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt )
Я нашел два способа документировать параметры в...
3099 просмотров
schedule
17.05.2023
Могу ли я использовать Sphinx для программного доступа к проанализированной документации?
Я могу использовать docutils для анализа строк документации в формате reStructuredText, но он не анализирует сами директивы, принадлежащие домену Python. Например, :type path: unicode анализируется как:
<field>...
601 просмотров
schedule
21.09.2022
Документация по Python и JavaScript/AngularJS на одном сервере?
К преимуществам такого подхода относятся:
Единый синтаксис docstring везде
Централизованный сервер документации; найти все свои документы в одном месте
Поиск и переход к исходному коду из любой документированной функции или класса; на...
631 просмотров
schedule
13.10.2022
Python устанавливает строку документации и получает имя метода динамически сгенерированного метода класса
Я пытаюсь получить/установить имя и строку документации динамически созданных методов класса следующим образом, но у меня возникли проблемы с выяснением того, как именно это сделать:
import sys
import inspect
class test(object):
pass...
966 просмотров
schedule
27.05.2023
Форматирование строк документации python для dicts
Каков рекомендуемый способ добавления строки документации для параметра словаря? Я могу увидеть примеры многострочных строк документации здесь .
Мне нужно задокументировать входные аргументы функции в строке документации. Если это простая...
23754 просмотров
schedule
27.07.2023
Как документировать kwargs с помощью эпитекста для подсказки автоматического завершения в PyCharm?
Можно ли получить дополнительную подсказку для kwargs, которая даст вам примеры предопределенных возможных аргументов ключевого слова? Может эпитекст его не поддерживает?
class Person():
def __init__(self, **kwargs):
"""...
2607 просмотров
schedule
07.12.2023
Как добавить авторство в строку документации NumPy в Python
Мы перешли с Sphinx на стиль строки документации NumPy, и .. sectionauthor:: больше не кажется, визуализировать правильно. Тем не менее, нам нужно иметь возможность назначать автора каждому методу класса.
Есть ли способ правильно добавить...
1821 просмотров
schedule
26.04.2023
Как избежать избыточности между документами C++ и boost::python?
Я добавляю модуль python в код C++, используя boost::python. Проект c++ задокументирован с помощью doxygen. Я хочу создать документацию для модуля python, но я не знаю, как не быть избыточным, как это:
#include <boost/python.hpp>
using...
552 просмотров
schedule
09.10.2023
Означает ли \r что-то в сфинксе?
Я пишу свою строку документации, следуя рекомендациям по созданию строки документации. Затем я использую autodoc sphinx для создания своей документации. В некоторых строках документации я использую формулы LaTeX (sphinx.ext.mathjax). Кажется, что...
534 просмотров
schedule
25.03.2024
Docstring — использование имени параметра и типа в python
Я написал несколько классов на Python и написал для них строки документации следующим образом:
class DB:
def execute_and_return(self, sql):
"""Execute the query and returns the result as a list of list
Parameters...
287 просмотров
schedule
13.09.2023
Должна ли Docstring содержать оператор Raises, если ошибка обрабатывается в коде
Предположим, у меня есть простая функция. Например:
def if_a_float(string):
try:
float(string)
except ValueError:
return False
else:
return True
Должен ли я включать оператор Raises: ValueError в свою строку...
51 просмотров
schedule
11.03.2024
Модифицированные строки документации в стиле sphinx в vscode
Все, я пробую это как в VSCode, так и в Pycharm. По сути, я хочу изменить стиль моей автоматически сгенерированной строки документации. В VSCode я использую расширение «Генератор строк документации Python». В настоящее время установка его на sphinx...
134 просмотров
schedule
21.11.2022
Python заставляет функцию класса распечатать строку документации вызываемой функции
Есть ли простой способ заставить методы класса возвращать строку документации функции, которую я написал в другом модуле, когда вызывается help(my_classfunction) ?
39 просмотров
schedule
03.06.2022
Уравнение латекса Sphinx ПРЕДУПРЕЖДЕНИЕ: встроенный латекс завершен с ошибкой [stdout] Нет файла math.aux
Я пытаюсь импортировать уравнение в стиле латекса, которое находится в моей строке документации сценария, но мне трудно переходить от одной ошибки к другой. Может ли кто-нибудь помочь мне в этом?
Я использую расширение «sphinx.ext.imgmath» в моем...
38 просмотров
schedule
16.10.2022
