huggingface / huggingface/diffusers

VaeImageProcessor.blur() docstring is missing blur_factor and has a copy-pasted description

Open Beginner friendly
#14,209 0 comments 0 reactions 0 assignees View on GitHub
bug needs-code-example pipelines
Dominant language
Python
Stars
34.5k
Forks
7.3k
Avg merge
3d 3h
Merged PRs (30d)
91

Description

`VaeImageProcessor.blur()`'s docstring is missing the `blur_factor` parameter entirely, and its
`Returns`/description text appears to be copy-pasted from a different method — it currently
describes converting an image to grayscale, not blurring it.

**Location:** `src/diffusers/image_processor.py`, `VaeImageProcessor.blur()`, around line 271.

**Proposed fix:** add the missing `blur_factor` entry to the `Args` section and correct the
description to accurately describe the blur behavior, matching the style of nearby docstrings
in the same file (1-3 sentences, no more).

I have a small, single-file fix ready and would like to open a PR for this if a maintainer can
confirm it's welcome — happy to follow whatever review process you prefer.

Contributor guide

Open the contributing guide

Research direction

Open src/diffusers/image_processor.py and read VaeImageProcessor.blur() alongside nearby docstrings. Update the Args and Returns/description text to document blur_factor and accurately describe blurring, keeping the existing style and length. Done when the single-file docstring matches the method’s behavior and nearby documentation conventions.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Quiet
Clarity
Clearly specified
Newbie friendliness
88/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.