pypsa-meets-earth/pypsa-earth

Ensure configuration parameters are up to date in documentation

Open

#1,341 opened on Feb 5, 2025

View on GitHub
 (3 comments) (0 reactions) (1 assignee)Python (349 forks)auto 404
documentationgood first issue

Repository metrics

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

Description

Revise the configuration section to ensure configuration parameters are mapped

  • To revise the configuration.rst file to ensure the proper configuration parameters are mapped accordingly. For example, in top configuration, custom_rules is missing

  • Check if all power configurations are available in the configtables

Contributor guide

Research direction
Compare the configuration.rst file with the actual configuration parameters in the source code and configuration tables to find missing mappings like custom rules.
Tech stack
python
Domain
documentation
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.
1-3 hours
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
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75