Deltares / Deltares/imod-python
mf6 package class docstrings: scalar values never mentioned as acceptable types
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 May 17, 2022, 17:03
For example, in the NPF package, only this is mentioned:
k: array of floats (xr.DataArray)
While a single scalar, or a value for every layer (CONSTANT LAYERED) is also allowed.
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
Start by locating the NPF package class docstrings, using the shown k description as the reference case. Update the documented accepted forms to include scalar values and values supplied for every layer, then review the affected docstrings to confirm the supported input types are consistently described.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100