Вопросы по теме 'docstring'
Добавление строк документации в namedtuples?
Можно ли простым способом добавить строку документации в namedtuple?
Я пытался
from collections import namedtuple
Point = namedtuple("Point", ["x", "y"])
"""
A point in 2D space
"""
# Yet another test
"""
A(nother) point in 2D space
"""...
14684 просмотров
schedule
11.04.2022
Как изменить строку документации класса TestCase в Python?
В Python 2.5 (на самом деле Jython) для класса UnitTest TestCase - нет метода SetUpClass, и __init__ на самом деле неприемлемо (без ссылки на себя). Когда я пытаюсь изменить строку документации внутри TestCase:
import os
fileName =...
1303 просмотров
schedule
02.08.2023
Как я могу распечатать строку документации файла Python при его выполнении?
У меня есть скрипт Python со строкой документации. Когда синтаксический анализ аргументов командной строки не удается, я хочу распечатать строку документации для информации пользователя.
Есть какой-либо способ сделать это?
Минимальный пример...
32431 просмотров
schedule
05.03.2023
Математическое выражение в строке документации неправильно отображается Sphinx
Я пытался выяснить, что не так с этим выражением в моей строке документации. Я использую расширение sphinx.ext.mathjax в python sphinx v1.2b. Строка документации:
.. math::
w_k^* = \min_{w_k} \ell_k(w_k) + \lambda\left(\alpha||w_k||_1...
2702 просмотров
schedule
03.07.2022
Python — использование decorator.py для сохранения строки документации метода
Меня интересует вызов метода экземпляра как метода класса, так и метода экземпляра. Это можно сделать с помощью декоратора class_or_instance следующим образом:
class class_or_instance(object):
def __init__(self, fn):
self.fn = fn...
974 просмотров
schedule
11.06.2023
Как запретить PyCharm заполнять строки документации?
Если я добавлю строку документации к методу, используя тройную кавычку, как только я наберу пробел после тройной кавычки, PyCharm заполнит строку документации параметрами, которые принимает метод, и возвращаемым значением, например так:
def...
3444 просмотров
schedule
20.09.2022
Доступ к комментарию пакета из программы Go?
Можно ли получить комментарий к пакету изнутри программы Go? Эквивалентный код Python:
#!/usr/bin/env python
"""
Program v1.0
"""
print(__doc__)
391 просмотров
schedule
24.02.2023
Автоматическое создание строк документации Python в Visual Studio Express 2013
Есть ли способ автоматически генерировать строки документации для python в Visual Studio Express 2013? Если я правильно помню, в PyCharm, если вы вводите «»» после заголовка функции/класса, он автоматически генерирует строку документации, похожую на...
763 просмотров
schedule
18.03.2023
Могу ли я отформатировать строку документации в python3
Я пытаюсь создать строку документации, которая будет принимать поля замены следующим образом.
def run_tests(args):
"""run tests on methods in {0}
usage: {0} --tests
""".format(__file__)
pass
но когда я запускаю...
2089 просмотров
schedule
08.07.2022
Создание API из строк документации Python, написанных в PEP8
Я написал код на Python. Я старался следовать общепринятым правилам написания полезных комментариев в начале функций. Мой стиль - PEP8, например.
def __init__(self, f_name=None, list_=None, cut_list=None, n_events=None, description=None):...
144 просмотров
schedule
17.06.2022
Что отличает аргумент с ключевым словом от аргумента без ключевого слова в Python?
Я пытаюсь понять разницу между аргументами, не являющимися ключевыми словами, и аргументами ключевого слова.
Мне кажется, что каждый аргумент можно использовать и как ключевой аргумент.
def print_employee_details(name, age=0, location=None):...
59 просмотров
schedule
21.02.2022
Как можно хранить три двойных кавычки в строке документации Python?
У меня есть большой логотип ASCII, который я хочу сохранить в строке документации. Этот логотип содержит несколько экземпляров трех последовательных двойных кавычек. Размер и сложность таковы, что экранирование отдельных символов нереально....
103 просмотров
schedule
22.12.2022
Как установить и получить строку документации с несколькими методами в clojure?
Я использую мультиметоды для анализа команд командной строки и их аргументов.
(defmulti run (fn [command args] command))
(defmethod run :default
[& _]
...)
^{:args "[command]"}
(defmethod run "help"
[_ & [args]]
"Display command...
183 просмотров
schedule
04.06.2023
Документирование назначенных функций первого класса
У меня есть функция, определенная с использованием первоклассной природы функций Python, а именно:
add_relative = np.frompyfunc(lambda a, b: (1 + a) * (1 + b) - 1, 2, 1)
Либо мне нужен способ добавить строку документации к функции,...
116 просмотров
schedule
06.02.2023
Измените формат reStructuredText в PyCharm для автоматического создания комментариев
В документации JetBrains говорится, что существует два формата для создания reStructuredText комментарии с подсказками :
:param param_type param_name: parameter description (type description is on the same line as the parameter description)....
429 просмотров
schedule
04.11.2022
PyDev не показывает строку документации
Я работаю с PyDev в Eclipse, и по какой-то причине он не показывает строку документации, когда я наводил курсор на функцию. Что также не работает, так это переход к функции при нажатии F3. Обе функции работают на компьютере моего коллеги. Мы...
256 просмотров
schedule
18.10.2022
Какой стиль PyCharm/IntelliJ использует для строк документации Python?
Я пытаюсь понять «экосистему решений» в отношении создания строк документации, а затем создания хорошей справочной документации с помощью PyCharm/IntelliJ.
Я привык к строкам документации в стиле Google, и меня смущает формат/стиль скелета строки...
1407 просмотров
schedule
12.10.2023
как отобразить строку документации Unicode, вызвав help () в режиме ожидания
Когда функция определена в Python, тройные кавычки представляют строку документации. Но азиатские символы, используемые в строке документации, неправильно отображаются в IDLE для MacOS. Они отображаются в виде строки Unicode, например '\ uc778 \...
288 просмотров
schedule
14.05.2022
Убедитесь, что проект Python правильно задокументирован
У меня есть куча проектов Python v3.6. Я использую codestyle, чтобы убедиться, что они совместимы с PEP8.
Есть ли способ использовать стиль кода (или любой другой инструмент), чтобы проверить, что все функции, классы и методы в моих модулях...
45 просмотров
schedule
10.10.2022
Утверждение и документация в классе для методов, ожидаемых в производных классах [дубликаты]
Скажем, я создаю класс с именем Bird, который я хочу использовать только как родительский класс, а производные классы должны иметь метод flap_wings :
class Bird:
def fly(self):
self.flap_wings()
Ожидаемый производный класс может...
303 просмотров
schedule
21.05.2022
