Вопросы по теме 'docstring'
Функция справки python: печать строк документации
Есть ли возможность распечатать вывод help('myfun'). Поведение, которое я вижу, заключается в том, что вывод печатается в std.out, а скрипт ожидает ввода данных пользователем (т.е. введите «q», чтобы продолжить).
Должна быть настройка, позволяющая...
30052 просмотров
schedule
22.11.2022
Избегайте строк документации от родителя в Sphinx
Я использую Sphinx для автодокументов, но меня раздражает то, как он по умолчанию добавляет строку документации родительского класса к моей строке документации.
В результате для каждого задокументированного тестового класса, унаследованного от...
627 просмотров
schedule
04.03.2023
Документирование возвращаемого типа кортежа в строке документации функции для подсказки типа PyCharm
Как я могу задокументировать, что функция возвращает tuple таким образом, чтобы PyCharm мог использовать его для подсказки типа?
Надуманный пример:
def fetch_abbrev_customer_info(customer_id):
"""Pulls abbreviated customer data from the...
19494 просмотров
schedule
18.01.2023
docstring блокирует инструкцию elif
Позвольте мне пропустить точный код, который у меня есть: это короткий модуль
class SentenceSplitter:
def __init__(self, filename=None):
self._raw_text = self.raw_text(filename)
self._sentences = self.to_sentences()
def raw_text(self,...
461 просмотров
schedule
10.04.2024
Как автоматически связать тип параметра в строках документации ReST в Sphinx?
Например, у меня есть следующий код:
# Solve for coefficients of quadratic approximation
def quad(p, x):
"""Solves for the coefficients of the quadratic approximation of a
polynomial ``p`` at points ``x``.
:param...
3099 просмотров
schedule
21.05.2023
строки документации в Juno
Сегодня я начал изучать Юлю. Я пробовал следующее на Juno, работая с Julia 0.3.8.
VERSION < v"0.4-" && import Docile
using Docile
@doc doc"""
Hello Hello ***world***
""" ->
function hello()
print ("Not bad")
end
В juno...
166 просмотров
schedule
30.06.2023
Как мне сгруппировать похожие исключения в строке документации?
Я не вижу упоминания об этом ни в одном руководстве по стилю. Должен ли я объединить похожие типы исключений или разделить их на отдельные строки:
"""
This is a Google style docs.
...
...
Raises:
TypeError: foo() missing 1 required positional...
62 просмотров
schedule
08.08.2022
Должны ли вы всегда документировать функции, даже если они избыточны (в частности, Python)?
Я стараюсь использовать активные и описательные имена функций, которые затем документирую активным и описательным текстом (!). Это генерирует избыточный код.
Упрощенный (но не такой уж нереалистичный) пример на питоне, следующий стилю numpy...
1309 просмотров
schedule
21.05.2022
Почему Python автоматически не экранирует «\» в __doc__?
Кажется, что некоторые escape-символы все еще имеют значение в строке документации. Например, если мы запустим python foo.py ( Python 2.7.10 ), он выдаст ошибку типа ValueError: invalid \x escape .
def f():
"""
do not deal with '\x0'...
3946 просмотров
schedule
29.09.2022
Строка документации NumPy для типа функции и типа None
Я пишу следующую функцию:
def parse_zip_file(path, handler):
"""
Parse all files contained in a zip file (specified by the path parameter).
Parameters
----------
path : str
The path to the zip file.
handler:...
948 просмотров
schedule
22.03.2023
Существует ли консенсус относительно того, что должно быть задокументировано в классах и строках документации __init__?
Я не нашел никаких рекомендаций относительно того, что должно быть задокументировано в классах и __init__ строках документации. Иногда я обнаруживаю, что аргументы конструктора уже задокументированы в строке документации классов, иногда они описаны...
19200 просмотров
schedule
19.11.2022
Есть ли что-то вроде C#, см. cref в строках документации Python ReST?
Я конвертирую некоторый код C# в Python 3, включая документацию, которая обычно записывается в виде сводок XML в исходном коде C#.
В этих сводках есть ссылки на имена классов в виде элемента <see cref="ClassName"/> или элементов...
203 просмотров
schedule
21.05.2022
sphinx: включая файл .tex через raw::latex
Я хочу включить латексный документ в sphinx. Сборка sphinx html не включает файл латекса, связанный с использованием директивы .. raw:: latex . У меня есть
это моя структура каталога
docs/
source/
importlatex.rst...
1928 просмотров
schedule
12.12.2022
Какова цель замыкания белых строк в строках документации Python?
Я видел завершающую белую строку в конце строк документации Python (например, в Numpy строках документации и в строках документации в стиле Google , и я помню, что где-то читал, что это предлагалось.
Тем не менее, они, кажется, игнорируются в...
87 просмотров
schedule
15.07.2022
Что такое соглашение PEP8 для документирования класса, который наследует другой класс?
Когда я пытаюсь следовать PEP8 и документировать строку класса, который включает наследование, проверка PyCharm/PyCode для PEP8 всегда выдает мне предупреждение о том, что унаследованные параметры не имеют ссылки. Эти лучше просто удалить? Должен ли...
1276 просмотров
schedule
04.04.2023
Как программно изменить строки документации в файле
Мне нужно изменить строки документации в куче файлов, чтобы добавить к ним значения входных параметров по умолчанию, если они присутствуют в конструкторе класса или сигнатуре функции.
Итак, скажем, у меня есть следующее:
# a bunch of code...
130 просмотров
schedule
24.11.2022
Ним эквивалентен python `help()`
Компилирует ли nim строки документации, чтобы мы могли выводить их во время выполнения?
Что-то типа:
>>> echo help(echo)
"Writes and flushes the parameters to the standard output.[...]"
182 просмотров
schedule
02.05.2024
Что означает S.find(sub[, start[, end]])?
Я учусь использовать строку документации python.
>>> print(str.find.__doc__)
S.find(sub[, start[, end]]) -> int
...
Когда я печатаю строку документации str.find(), я не понимаю, что это значит.
Что означает S.find(sub[, start[,...
189 просмотров
schedule
09.10.2023
Должен ли я перечислять методы класса в строке документации класса?
Меня немного смущает стандарт PEP257 для документирования классов.
В нем говорится: «Строка документации для класса должна обобщать его поведение и перечислять общедоступные методы и переменные экземпляра».
Но там же написано, что все функции...
1342 просмотров
schedule
27.01.2023
Каков тип объекта, который создает экземпляры классов в python?
У меня проблема, которую я даже не знаю, как искать. Посмотрите на этот простой класс в качестве примера:
class Student(object):
def _init_(self):
self.id = 0
def inc(self):
self.id += 1
std_gen = Student
Какой...
48 просмотров
schedule
20.08.2023
