Deltares / Deltares/MeshKernelPy
Improve documentation of `mesh2d_delete_small_flow_edges_and_small_triangles`
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 27
- Forks
- 5
- PR merge metrics
- No merged PRs in 30d
Description
What is the need for this task.
The function mesh2d_delete_small_flow_edges_and_small_triangles raises several questions.
What is the task?
There was an explanation given in https://github.com/Deltares/dfm_tools/issues/812#issuecomment-2046910287 about mesh2d_delete_small_flow_edges_and_small_triangles. This function is also documented, but this is a bit less clear than in the issue comment. I suggest to slightly clarify this:
https://github.com/Deltares/MeshKernelPy/blob/ceba1501bd85ba56170a37665d4c5012019c614d/meshkernel/meshkernel.py#L997-L1004
It would also be good if sensible argument default vlaues are set or mentioned in the docstring.
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 in meshkernel/meshkernel.py at the documentation for mesh2d_delete_small_flow_edges_and_small_triangles, and compare it with the explanation in Deltares/dfm_tools#812. Clarify the function behavior and ensure sensible argument default values are set or documented; the docstring should answer the questions raised by the issue.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100