Описание тега docstring
Строка документации - это строка, которая встречается в качестве первого оператора в определении модуля, функции, класса или метода и используется для документирования объекта, в котором она встречается.
1
ответ
Python устанавливает строку документации и получает имя метода динамически генерируемого метода класса
Я пытаюсь получить / установить имя и строку документации динамически создаваемых методов класса следующим образом, но у меня возникают проблемы с выяснением, как именно это сделать: import sys import inspect class test(object): pass @classmethod de…
01 окт '14 в 15:35
8
ответов
Что такое стандартный формат документации Python?
Я видел несколько разных стилей написания строк документации на Python, есть ли официальный или "согласованный" стиль?
10 окт '10 в 01:10
1
ответ
GNU emacs lisp: что делает макрос with-wrapper-hook? Не могли бы вы предоставить описание и примеры?
Я нахожу онлайн-справку неинформативной для этого макроса. Возможно, Stackru может сделать лучше? Я использую транк Emacs (24.0.50.1) в случае, если это имеет значение. Спасибо!
17 сен '11 в 00:59
1
ответ
Показывать строки документов при каждом вызове функции
Допустим, у меня есть такой код: class NewTestCase(unittest.TestCase, CommonMethods): def setUp(self): self.shortDescription() def test_01_sample test(self): """Testing something""" self.create_account(self.arg['account']) assert ... ... class Commo…
02 июл '14 в 14:26
2
ответа
PyDev не показывает строку документации
Я работаю с PyDev над Eclipse, и по какой-то причине он не показывает строку документации при наведении курсора на функцию. Что также не работает, это перейти в функцию при нажатии F3. Обе функции работают на компьютере моего коллеги. Мы попробовали…
23 июн '17 в 08:16
1
ответ
sphinx: включая файл.tex через raw:: latex
Я хочу включить латекс док в сфинкс. Сборка sphinx html не содержит латексный файл, связанный с помощью .. raw:: latex директивы. я имею это моя структура dir docs/ source/ importlatex.rst index.rst build/ tex/ texfile.tex index.rst похоже Welcome t…
12 июл '17 в 17:39
2
ответа
Как добавить константную строку в __doc__ для всех методов класса?
У меня есть код, который выглядит так: constString = """ Default docstring info: 1 2 3""" class A(): def A1(): """ First unique docstring. """ pass def A2(): """ Second unique docstring. """ pass B = A() print(B.A1.__doc__) Если я запускаю этот код,…
03 дек '13 в 17:30
1
ответ
Строка документации Python с vim pythoncomplete не отображает переводы строк для моих собственных функций класса
Я получаю некоторые неожиданные результаты, когда пытаюсь использовать Python Omni Completion в своих собственных функциях класса. Строка документации для функций неправильно форматируется с переносами строк, как показано на рисунке ниже: Когда я им…
02 апр '12 в 16:50
1
ответ
Как добавить строку документации Python для dict
Каков рекомендуемый способ добавления строки документации для параметра словаря? Я могу увидеть несколько строк документации doc-string здесь. Мне нужно документировать входные аргументы функции в строке документации. Если это простая переменная, я …
03 ноя '14 в 10:45
2
ответа
Ошибка "Ожидается блок с отступом"?
Я не могу понять, почему Python выдает ошибку "Ожидаемый блок отступов"? """ This module prints all the items within a list""" def print_lol(the_list): """ The following for loop iterates over every item in the list and checks whether the list item …
29 окт '13 в 11:57
1
ответ
Какова цель перемещения белых линий в строках документации Python?
Я видел завершающую белую линию в конце строки документации Python (как в Numpy docstrings и в docstrings стиля Google, и я помню, читал где-то, что это было предложено. Тем не менее, они, кажется, игнорируются в конвертерах документов, таких как в …
09 авг '17 в 10:29
3
ответа
Можете ли вы передать аргумент None, если для строки документации требуется строка?
Хорошо, на этот вопрос, возможно, где-то был дан ответ, но мой Google-фу еще не нашел правильную комбинацию ключевых слов. У меня есть функция, которая принимает строку, но когда я передаю None, проверка Pycharm отмечает ошибку типа. Это ошибка в ли…
09 авг '17 в 15:14
1
ответ
Документация Python и JavaScript/AngularJS на одном сервере?
Преимущества этого подхода включают в себя: Согласованный синтаксис документации везде Централизованный сервер документации; найти все свои документы в одном месте Поиск и переход к источнику из любой задокументированной функции или класса; на любом…
20 янв '14 в 07:49
2
ответа
Разница между ":", "@" и ничем в строках документации python
Я просто пытаюсь лучше понять расположение строк документации Python (Между """ """) Я видел строки документации с различными макетами... такими как... """ @DESCRIPTION Ive seen tags STARTING with an at-sign :DESCRIPTION: Tags with colons DESCRIPTIO…
30 май '14 в 12:00
2
ответа
Разбор строк документации Python (и вообще разбор языков в Python)
Я хотел бы создать полезную документацию для API REST, написанного на Python. Я думаю, что это должно быть что-то вроде этого: ''' /kittens/ This method creates kittens in the browser HTTP Params: format(default=json): The format in which kittens wi…
29 мар '11 в 14:42
6
ответов
Наследование строк документации методов в Python
У меня есть OO-иерархия со строками документации, которые требуют столько же обслуживания, сколько и сам код. Например, class Swallow(object): def airspeed(self): """Returns the airspeed (unladen)""" raise NotImplementedError class AfricanSwallow(Sw…
11 ноя '11 в 21:26
4
ответа
Написание строк документации - указание функций аргументов и возвратов
Предположим, у меня есть функция, скажем: >>> def foo(a): return a+1 Я хочу написать строку документации для него. Каково соглашение при указании в строке документации, что он принимает и возвращает +1?
24 дек '10 в 05:38
2
ответа
Python. Подсказка для переменной
Я использую PyCharm как редактор. Например, у меня есть следующая функция: def get_instance(): # method without doc sctring in some module # returns instance of MyClass return some_var И у меня есть второй файл, который вызывает get_instance(): var …
11 ноя '16 в 15:09
1
ответ
RestructuredText в Sphinx и Docstrings: одинарные или двойные обратные кавычки или обратные тики
Из документации видно, что двойная обратная кавычка используется для литералов, в то время как одинарная обратная кавычка используется, когда есть код текста, который нужно интерпретировать. Это привело бы меня к написанию документации для метода f(…
07 мар '14 в 17:40
1
ответ
Как я могу разобрать строку документации numpydoc и получить доступ к компонентам?
Я хотел бы проанализировать строку документации numpydoc и получить программный доступ к каждому компоненту. Например: def foobar(a, b): '''Something something Parameters ---------- a : int, default: 5 Does something cool b : str Wow ''' Что я хотел…
20 июн '16 в 18:56