POSYDON-code/POSYDON

Reformating and updating all docstrings + adding missing ones.

オープン

#187 opened on 2023/11/08

 (1 件のコメント) (0 件のリアクション) (1 人の担当者)Python (35 件のフォーク)auto 404
P2 - medium prioritydocumentationenhancementgood first issue

Repository metrics

Stars
 (42 個のスター)
PR merge metrics
 (PR metrics pending)

説明

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

コントリビューターガイド