Результаты поиска по запросу "docstring"

1 ответ

Документирование типа возврата `tuple` в строке документации функции для хинтинга типа PyCharm

1 ответ

Что означают эти форматы в витой документации?

В искаженном исходном коде многие строки документации содержат такие форматы: L {xxx} или C {xxx}, или строка начинается с символа @, каковы их значения? на...

0 ответов

Обычно целью добавления добавления строки документа в начало функции является описание функции, что она делает, что она будет возвращать, и описание параметров. Вы можете добавить детали реализации, если это необходимо. Даже вы можете добавить информацию об авторе, который написал код для будущего разработчика.

по вашему мнению, является значимой строкой документации? Что вы ожидаете, что там будет описано? Например, рассмотрим этот класс Python__init__: def __init__(self, name, value, displayName=None, matchingRule="strict"): """ name - field name ...

ТОП публикаций

2 ответа

Pycharm: автоматически генерировать `: type param:` поле в строке документации

1 ответ

В чем преимущество наличия многострочных и однострочных строковых литералов в Python?

2 ответа

Почему строка документации Python интерпретируется иначе, чем комментарий

Допустим, у меня есть такая функция: def myFunc(): # useful function to calculate stuffЭто приведет к ошибке отступа, если я не добавлюpass: def myFunc(): # useful function to calculate stuff passОднако, если я заменю комментарий на строку ...

1 ответ

Документирование типа возврата `tuple` в строке документации функции для хинтинга типа PyCharm

Как я могу документировать, что функция возвращаетtuple таким образом, что PyCharm сможет использовать его для подсказок типа? Придуманный пример: def fetch_abbrev_customer_info(customer_id): """Pulls abbreviated customer data from the database ...

2 ответа

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

На этот вопрос уже есть ответ: Как указать несколько типов возвращаемых данных, используя подсказки типа [/questions/33945261/how-to-specify-multiple-return-types-using-type-hints] 2 ответа В документации на Python как следует ...

1 ответ

Ссылка на параметры в строке документации Python

Я использую Sphinx и функцию autodocs, чтобы у нас были хорошие документы в нашем проекте.Так что я'я знаком ссписки информационных полей и я'я знако...

1 ответ

Ссылка на параметры в строке документации Python

Я использую Sphinx и функцию autodocs, чтобы у нас были хорошие документы в нашем проекте. Итак, я знаком ссписки информационных полей [http://sphinx-doc.org/domains.html#info-field-lists]и я знаком с использованием перекрестные ...