Python dict 的 NumPy 风格文档

Question

基于this，列表参数应记录如下：

Parameters
----------
param1 : :obj:`list` of :obj:`str`

您将如何记录字典参数？

相关问题：添加 :obj: 似乎使 list 可点击（intellij doc.preview ~ ctrl+q）但是没有提到 str 了，这看起来很奇怪。那么上面的约定是否仍然正确？

Parameters
----------
param1 : list of str

推理：试图在我的文档中保持一些标准，并且由于我大量使用 NumPy，我宁愿坚持这一点

Answer 1

variable : dict of str
    description

当 intellij 设置为 NumPy docstring 格式（Python 集成工具）时将显示 Dict[str]

Python NumPy-style documentation of dict