docstring

2зной

3ответ

Существует ли консенсус относительно того, что должно быть документировано в классах и __init__ docstrings?

Я не нашел лучшей практики о том, что должно быть задокументировано в классах, и __init__ docstrings. Иногда я нахожу, что аргументы конструктора уже задокументированы в классах docstring, иногда они

3зной

1ответ

Любые причины для ввода кода перед docstring в Python?

Я вижу в коде других Python других людей, что они вставляют некоторые проверки перед docstring функции; что-то вроде этого: def func(args): if x_version != 1.7: return """docstring is h

0зной

1ответ

Держите линии внутри докстеров в пределах 79 символов.

Я пишу некоторые доктрины в своем модуле. Соответствующий код def foo(): """ Populates the database with 'VALUES' >>> import sqlite3 >>> con = sqlite3.connect('test.db') >>>

1зной

1ответ

Что означает «просмотр docstring экземпляра объекта для получения дополнительной информации» означает

Я чувствую, что это глупый вопрос, но когда я нахожусь в ноутбуке IPython, и я помогаю в некоторой функции numpy/scipy, например say stat. norm.rvs, он часто говорит, о * args и ** kargs, "см. docstri

2зной

1ответ

Latex команда \ бар не работает должным образом в Python строки документации

У меня есть функция с строкой документацией следующим образом, def func(x): '''Boring function Notes ----- Let :math:`\bar{x}_k = \sum_{i=1}^{n_k}x_{ik}`, ''' return x

3зной

1ответ

Возможно ли добавление докстеров для всех функций в PyCharm?

У меня есть проект python, в котором многие функции и классы пропускают docstrings. Я знаю, что PyCharm может автоматически добавлять docstrings на Вставить строку документации stub команда с использо

2зной

1ответ

Python строки документации неожиданно None

Когда я создаю класс с методом, как это: class Foo: """ A class """ def bar(): " Hello world " pass я ожидал бы __doc__ вернуть первое утверждение метода, так как являются стро

6зной

2ответ

Как мне документировать: rtype: для функции, которая возвращает несколько возможных типов данных?

В документе docstring для Python следует документировать :rtype: для функции, которая может возвращать несколько возможных типов данных? Например, если функция может возвращать defaultdict ИЛИ dict ИЛ