docs: fix 14 typos in docs, comments and docstrings by iridescentWen · Pull Request #14541 · huggingface/diffusers · GitHub
Skip to content

docs: fix 14 typos in docs, comments and docstrings - #14541

Merged
stevhliu merged 1 commit into
huggingface:mainfrom
iridescentWen:docs/more-typos-v2
Aug 20, 2026
Merged

stevhliu merged 1 commit into
huggingface:mainfrom
iridescentWen:docs/more-typos-v2

Conversation

@iridescentWen

Copy link
Copy Markdown
Contributor

Follow-up to #14345 (merged), taking up @stevhliu's "feel free to include others here as well!" —
that PR is closed now, so these are in a separate one.

14 spelling fixes across docs, comments, and docstrings. No behavior change except that two of them
are in user-visible ValueError text.

What's fixed

Where Fix
docs/.../bria_fibo.md proffesional → professional
docs/.../memory.md maxmium → maximum; heigh → height (in the channels_last tensor-shape explanation, where the wrong word makes the shape wrong)
docs/.../wan.md typo in prose
guiders/magnitude_aware_guidance.py supression → suppression (docstring)
models/attention.py spliting → splitting (comment)
models/attention_dispatch.py abritrary → arbitrary ×2 (comment)
models/transformers/transformer_ltx2.py timstamps → timestamps ×2 (comments)
pipelines/deprecated/unidiffuser/modeling_uvit.py tbe → the (docstring Returns:)
pipelines/ltx2/pipeline_ltx2*.py corrct → correct ×2 (TODO comments)
pipelines/visualcloze/pipeline_visualcloze_{combined,generation}.py whe they → when they ×2 — user-visible, inside raise ValueError(...) in check_inputs

Deliberately excluded

Verified and left alone, so they don't look like oversights:

  • promt / scren in pipeline_kandinsky*.py — these sit inside prompt_template strings that
    are fed verbatim to the text encoder. Fixing the spelling would change generated output, which is a
    behavior change, not a typo fix.
  • ANE, MoT — initialisms (Apple Neural Engine, Mixture-of-Transformers).
  • racoon — appears in prompt examples whose reference images were generated with that exact
    (misspelled) prompt, so the example and the image would stop matching.
  • Shuting Wang — a paper author's name.

Validation

Rebased onto main @ 4e0466f3e; the original commit cherry-picked cleanly, so all 14 sites still
exist upstream.

$ uvx ruff check <the 9 changed .py files>
All checks passed!

$ uvx ruff format --check <the 9 changed .py files>
9 files already formatted

git diff --stat: 12 files, +14/-14.

Self-review (per CONTRIBUTING)

Ran the .ai/skills/self-review rubric against .ai/review-rules.md:

  • Blocking issues: none. The diff is spelling-only; no logic, no signatures, no defaults changed.
  • # Copied from (AGENTS.md): checked explicitly, because the two visualcloze files fix the
    same error string and that is the shape a copy-link usually takes. Both changed lines are inside
    check_inputs (generation.py:404, combined.py:170), and neither method carries a
    # Copied from header — the markers in those files sit on _get_t5_prompt_embeds,
    _get_clip_prompt_embeds, _encode_vae_image, get_timesteps, _pack_latents. So editing both
    by hand is correct here rather than fixing an upstream source and running make fix-copies.
  • Ephemeral context: none added — no # per review style comments.
  • Documentation impact: none. No public behavior, argument, or default changes, so no docs/
    updates are implied beyond the two doc typos already included.
  • Dead code analysis: not applicable (no new model).

I could not run python utils/check_copies.py locally — utils/ is outside my sparse checkout — so
the copy-link check above is the manual equivalent. CI's check_repository_consistency will confirm.


🤖 Written with Claude Code. Every one of the 14 sites was read in
context, and the four excluded classes were each checked rather than assumed.

Prose, comments and docstrings only. No executable line changed.

docs/:
- optimization/memory.md: maxmium -> maximum; heigh -> height (in the
  channels_last layout tuple, which read "(batch size, heigh, width,
  channels)")
- api/pipelines/bria_fibo.md: proffesional -> professional
- api/pipelines/wan.md: involed -> involved

src/ comments and docstrings:
- guiders/magnitude_aware_guidance.py: supression -> suppression
- models/attention.py: spliting -> splitting
- models/attention_dispatch.py: abritrary -> arbitrary (x2)
- models/transformers/transformer_ltx2.py: timstamps -> timestamps (x2)
- pipelines/ltx2/pipeline_ltx2{,_image2video}.py: corrct -> correct
- pipelines/deprecated/unidiffuser/modeling_uvit.py: tbe -> the
- pipelines/visualcloze/pipeline_visualcloze_{combined,generation}.py:
  "whe they are lists" -> "when they are lists" in a user-facing
  ValueError message

Deliberately not touched:
- pipeline_kandinsky*.py "promt"/"scren" live inside prompt_template,
  which is fed to the text encoder verbatim. Changing them would change
  generation output.
- ANE (Apple Neural Engine), MoT (Mixture-of-Transformers): initialisms.
- "racoon": appears in prompt examples whose reference images were
  generated with that exact prompt.
- "Shuting Wang": a paper author's name.
@github-actions github-actions Bot added size/S PR with diff < 50 LOC documentation Improvements or additions to documentation models pipelines guiders labels Aug 20, 2026

@stevhliu stevhliu left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nice, thanks!

@HuggingFaceDocBuilderDev

Copy link
Copy Markdown

@stevhliu
stevhliu merged commit 2f7e015 into huggingface:main Aug 20, 2026
15 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation guiders models pipelines size/S PR with diff < 50 LOC

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants