POSYDON-code/POSYDON

Reformating and updating all docstrings + adding missing ones.

Open

#187 opened on Nov 8, 2023

View on GitHub
 (1 comment) (0 reactions) (1 assignee)Python (35 forks)auto 404
P2 - medium prioritydocumentationenhancementgood first issue

Repository metrics

Stars
 (42 stars)
PR merge metrics
 (PR metrics pending)

Description

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

Contributor guide

Research direction
Review each module's docstrings for format and completeness. Use tools like pydocstyle to check formatting. Update parameters and descriptions according to latest code.
Tech stack
python
Domain
backend
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
PythonGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75