ImperialCollegeLondon / ImperialCollegeLondon/SWMManywhere

`graphfcn` sub-modules aren't in API documentation

Open Beginner friendly
#360 1 comment 0 reactions 0 assignees View on GitHub
documentation
Dominant language
Python
Stars
51
Forks
11
PR merge metrics
No merged PRs in 30d

Description

e.g., search `clip_to_catchment` [here](https://imperialcollegelondon.github.io/SWMManywhere/)

These are the modules within `src/swmmanywhere/graphfcns`

Contributor guide

Open the contributing guide

Research direction

Start with the API documentation linked in the issue and compare it with the modules under src/swmmanywhere/graphfcns, including clip_to_catchment. Find the documentation entry point that controls which sub-modules are included, then update that configuration. Done means the graphfcn sub-modules are visible and searchable in the published API documentation.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
64/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.