Как ссылаться на задокументированный параметр функции Python с помощью разметки Sphinx?Python

Программы на Python
Ответить Пред. темаСлед. тема
Anonymous
 Как ссылаться на задокументированный параметр функции Python с помощью разметки Sphinx?

Сообщение Anonymous »

Я хотел бы ссылаться на ранее документированный параметр функции в другом месте в Python Docstring. Рассмотрим следующий (по общему признанию полностью искусственный) пример: < /p>

def foo(bar):
"""Perform foo action
:param bar: The bar parameter
"""

def nested():
"""Some nested function that depends on enclosing scope's bar parameter.
I'd like to reference function foo's bar parameter here
with a link, is that possible?"""
return bar * bar

# ...
return nested()
< /code>

Есть ли простой способ встроить ссылку на параметр с использованием разметки Sphinx, или это произойдет автоматически?>

Подробнее здесь: https://stackoverflow.com/questions/111 ... inx-markup
Реклама
Ответить Пред. темаСлед. тема

Быстрый ответ

Изменение регистра текста: 
Смайлики
:) :( :oops: :roll: :wink: :muza: :clever: :sorry: :angel: :read: *x)
Ещё смайлики…
   
К этому ответу прикреплено по крайней мере одно вложение.

Если вы не хотите добавлять вложения, оставьте поля пустыми.

Максимально разрешённый размер вложения: 15 МБ.

  • Похожие темы
    Ответы
    Просмотры
    Последнее сообщение

Вернуться в «Python»