python - 如何在一行 ReST 文档字符串中指定返回类型并描述返回值?

标签 python restructuredtext docstring

我知道我可以缩写以下 ReST 文档字符串

"""
:type flag: bool
:param flag: new value for the flag
"""

作为

"""
:param bool flag: new value for the flag
"""

我可以用类似的方式缩写以下内容吗?

"""
:rtype: bool
:returns: new value of flag
"""

最佳答案

这是不可能的。必须在 returnsreturn 中指定描述,并在 rtype 中指定返回类型。不允许将它们合并到一行中。

关于python - 如何在一行 ReST 文档字符串中指定返回类型并描述返回值?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/48095851/

相关文章:

python - 处理错误: Not a directory python

python - 如何绘制分类报告?

python - 如何可靠地检测 python 文档字符串是否处于静止状态?

python - Latex 命令\栏在 Python 文档字符串中无法正常工作

python - 将任何模块中定义的函数的文档字符串存储为字符串

创建二维 numpy 数组的 Pythonic 方式

python - django app_details() 收到意外的关键字参数 'slug' 错误

python-sphinx - 如何在 Python-sphinx(文档工具)中插入元数据

python-sphinx - 如果可能,我们如何在 rst 文件的代码部分中放置超链接?

python - 将文档字符串中的预期结果指定为十六进制?