[WIP] chore: add utilities to check if call/forward methods are documented.

[sayakpaul]

What does this PR do?

To have some much-needed consistency in our docstrings where it should matter.

The diff seems large because of the docstring stuff. Main stuff is under .github/workflows/, utils/check_forward_call_docstrings.py, and Makefile.

[stevhliu]

very nice!

should we run the checker locally and see what pops up and include the cleanups here before landing this pr?

[sayakpaul]

should we run the checker locally and see what pops up and include the cleanups here before landing this pr?

We can actually run python utils/check_forward_call_docstrings.py locally to get a list of what needs fixing. The CI is also reporting those.

Do we want to fix them in this PR?

[stevhliu]

oh i see it now, wow this is really handy! i'm ok with either fixing here or in separate pr :)

[sayakpaul]

i'm ok with either fixing here or in separate pr :)

Do you maybe want to branch off of this PR branch and open a PR to this one with the fixes?

[HuggingFaceDocBuilderDev]

The docs for this PR live here. All of your documentation changes will be reflected on that endpoint. The docs are available until 30 days after the last update.

[yiyixuxu]

thanks,
not merge-blocking, but I think, it could make a better developer experience if we also add a placeholder entry for missing arg & remove the ones not exist

[github-actions]

Claude finished @yiyixuxu's task in 9m 42s —— View job

---

Adding --fix option to check_forward_call_docstrings.py

• Read and understand the existing script
• Implement --fix option that adds placeholders for missing args and removes non-existing args
• Verify implementation
• Commit changes

Summary

Added a --fix flag to utils/check_forward_call_docstrings.py that automatically fixes docstring/signature mismatches:

Usage:

python utils/check_forward_call_docstrings.py --fix
# Or for specific files:
python utils/check_forward_call_docstrings.py --fix --paths src/diffusers/models/transformers/transformer_flux.py

What it does:

1. Missing arguments — adds a placeholder entry (arg_name: TODO - add description.) to the Args section. If no Args section exists, one is created.
2. Stale arguments — removes documentation entries for arguments that no longer exist in the method signature.

New functions added:

• _get_docstring_node() — locates the AST node for a method's docstring
• _find_args_section_in_source() — finds the Args section boundaries in raw source lines
• _parse_entry_ranges() — parses individual arg entries with their line ranges for clean removal/preservation
• fix_file() — orchestrates the fixes for a single file, applying changes in reverse source order to preserve line numbers

[yiyixuxu]

(testing , ignore us....)

@claude can you open a PR to add an option "--fix" that:

1. add a placeholder for missing argument
2. remove the non-existing argument

COMMIT THIS

[github-actions]

ℹ️ COMMIT THIS was requested, but Claude didn't edit any files under .ai/ or src/diffusers/, so no follow-up PR was opened. See workflow run.

[github-actions]

Claude finished @yiyixuxu's task in 9m 53s —— View job

---

Adding --fix option to check_forward_call_docstrings.py

• Read and understand the existing script
• Implement --fix option that adds placeholders for missing args and removes non-existing args
• Verify implementation
• Commit changes

Summary

Added a --fix flag to utils/check_forward_call_docstrings.py that automatically fixes docstring/signature mismatches:

Usage:

python utils/check_forward_call_docstrings.py --fix
# Or for specific files:
python utils/check_forward_call_docstrings.py --fix --paths src/diffusers/models/transformers/transformer_flux.py

What it does:

1. Missing arguments — adds a placeholder entry (arg_name: TODO - add description.) to the Args section. If no Args section exists, one is created.
2. Stale arguments — removes documentation entries for arguments that no longer exist in the method signature.

New functions added:

• _get_docstring_node() — locates the AST node for a method's docstring
• _find_args_section_in_source() — finds the Args section boundaries in raw source lines
• _parse_entry_ranges() — parses individual arg entries with their line ranges for clean removal/preservation
• fix_file() — orchestrates the fixes for a single file, applying changes in reverse source order to preserve line numbers

[github-actions]

ℹ️ COMMIT THIS was requested, but Claude didn't edit any files under .ai/ or src/diffusers/, so no follow-up PR was opened. See workflow run.