代码之家  ›  专栏  ›  技术社区  ›  Dimebag

dict的Python NumPy风格文档

  •  0
  • Dimebag  · 技术社区  · 7 年前

    基于 this ,列表参数应记录如下:

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

    如何记录dict参数?

    相关问题:添加 :obj: 似乎使 list 可点击(intellij文档预览~ ctrl+q),但没有提及 str 这似乎很奇怪。那么,上述约定是否仍然正确?

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

    理由:试图在我的文档中保持一些标准,由于我大量使用NumPy,我宁愿坚持这样做

    1 回复  |  直到 7 年前
        1
  •  0
  •   Dimebag    6 年前
    variable : dict of str
        description
    

    将显示 Dict[str] 当intellij设置为NumPy doctstring格式(Python集成工具)时