Deltares / Deltares/imod-python
Change package names in examples
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 41
- Forks
- 12
- Avg merge
- 21h 8m
- Merged PRs (30d)
- 1
Description
In GitLab by @Huite on Oct 13, 2022, 17:09
The current examples suggest duplication, e.g.:
model["riv"] = imod.mf6.River()
We should instead use different names as the key, since it doesn't suggest that the name is informative for the type; it's just a label.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Search the repository examples for model["riv"] = imod.mf6.River() and other duplicated package-style keys. Update the examples so keys are distinct labels rather than suggesting they identify the type, then review the affected examples to confirm the naming is consistent.
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
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100