Deltares / Deltares/imod-python
Add images to the FAQ
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 Sep 19, 2022, 09:28
Based on direct feedback I got: for a quick grasp of what is meant in the FAQ, it might be useful to add some images.
E.g. for the smoothing via convolution:
Scikit image is a rather nice example:
Can be done in a piecewise manner, and optional of course...
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 FAQ content and reviewing the existing explanation of smoothing via convolution. Use the linked scikit-image example as reference for suitable visuals, then add images piecewise where they improve understanding and verify that the FAQ renders them correctly.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100