For `kernel_size` parameter, the doc of `GaussianBlur()` doesn't explain which is width or height
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 17.9k
- Forks
- 7.3k
- Avg merge
- 1d 15h
- Merged PRs (30d)
- 13
Description
📚 The doc issue
For kernel_size parameter, the doc of GaussianBlur() doesn't explain which is width or height as shown below so we don't know which is which:
Parameters:
- kernel_size (int or sequence) – Size of the Gaussian kernel.
Suggest a potential alternative/fix
So the doc should explain which is width or height as shown below:
Parameters:
- kernel_size (int or sequence) – Size of the Gaussian kernel
[width, height].
Or:
Parameters:
- kernel_size (int or sequence) – Size of the Gaussian kernel
[height, width].
Contributor guide
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 with the linked GaussianBlur API documentation and the implementation or existing transform conventions to determine whether kernel_size is ordered as width, height or height, width. Update the kernel_size parameter description to state the verified order, then confirm the generated documentation presents the clarification unambiguously.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- computer-vision, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 52/100