pypsa-meets-earth/pypsa-earth

Missing config tables and docstrings for some scripts

Open

#573 opened on Jan 22, 2023

View on GitHub
 (2 comments) (0 reactions) (0 assignees)Python (349 forks)auto 404
documentationgood first issuehelp wanted

Repository metrics

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

Description

Describe the feature you'd like to see

The configtables for several pypsa-earth-related scripts are missing. A non-exhaustive list is the following:

  • download_osm_data docstring&configtables
  • clean_osm_data docstring&configtables
  • build_shapes docstring&configtables
  • build_osm_network docstring&configtables
  • base_network only configtables
  • "load_options"; need for creating the build_demand and move the option as well accordingly

Contributor guide

Research direction
Look at existing scripts to understand the pattern for docstrings and config tables, then apply to the listed scripts.
Tech stack
python
Domain
backenddocumentation
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
PythonGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70