Improve documentation of `mesh2d_delete_small_flow_edges_and_small_triangles`
Nobody has claimed this yet.
Assessment
- Difficulty
- 1/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 55/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- python
- Domain
- documentation
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.
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.
- Dominant language
- Python
- Stars
- 27
- Forks
- 5
- PR merge metrics
- No merged PRs in 30d
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.
More from Deltares/MeshKernelPy
-
chore
Difficulty 4/5 3-5 days Newbie friendliness 35/100
Deltares/MeshKernelPy#284 ·
-
bug
Difficulty 3/5 1-2 days Newbie friendliness 65/100
Deltares/MeshKernelPy#279 · 1 comment ·
-
chore
Difficulty 3/5 1-2 days Newbie friendliness 25/100
Deltares/MeshKernelPy#251 · 2 comments ·
-
bug
Difficulty 4/5 3-5 days Newbie friendliness 25/100
Deltares/MeshKernelPy#236 · 1 comment ·
-
chore
Difficulty 4/5 3-5 days Newbie friendliness 45/100
Deltares/MeshKernelPy#190 ·
All issues in Deltares/MeshKernelPy
Similar issues
-
documentation help wanted
Difficulty 2/5 1-3 hours Newbie friendliness 90/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 90/100
simonw/sqlite-utils#872 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100