我正在使用Sphinx從我的docstrings中生成我的HTML文檔,比如一個好的'Pythonista'。 我有一個文檔字符串看起來像這樣: def do_a_thing(text):
'''
Call the ``str.strip()`` method on ``text``. Then do something
else with it.
'''
我有幾個函數(a,b和c),我希望他們使用相同的文檔字符串。所以我的計劃是通過只寫一次文檔字符串並將其保存到變量DOCSTRING來保存行。然後我將它放在函數聲明下。我沒有發現任何在PEP 257,解決我的問題...... DOCSTRING = '''
This is a docstring
for functions:
a,
b,
c'''
def a(x, y):
D
我想添加一些支持自動完成到我的Python代碼Jedi。這可以通過使用函數文檔字符串或類型提示(或兩者)來完成。 def function_with_types_in_docstring(param1, param2):
"""Example function with types documented in the docstring.
:type param1: int