POSYDON-code/POSYDON

Reformating and updating all docstrings + adding missing ones.

开放

#187 创建于 2023年11月8日

 (1 条评论) (0 个反应) (1 位负责人)Python (35 个派生)auto 404
P2 - medium prioritydocumentationenhancementgood first issue

仓库指标

星标
 (42 个星标)
PR 合并指标
 (PR 指标待抓取)

描述

With the automatic creation of the reference from the docstrings we need to check them:

  • check format:
    • here I already checked the format of citations
    • mainly checking the correct indentation, missing black lines, and other warnings and errors
  • update information, e.g. some have more parameters then explained, or some contain outdated information or the information is too much/less detailed
  • add missing ones

贡献者指南