Skip to content

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

Open
sayakpaul wants to merge 5 commits into
mainfrom
forward-call-checking
Open

[WIP] chore: add utilities to check if call/forward methods are documented.#13758
sayakpaul wants to merge 5 commits into
mainfrom
forward-call-checking

Conversation

@sayakpaul
Copy link
Copy Markdown
Member

@sayakpaul sayakpaul commented May 15, 2026

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.

@github-actions github-actions Bot added CI size/L PR with diff > 200 LOC labels May 15, 2026
@sayakpaul sayakpaul requested a review from stevhliu May 19, 2026 05:19
Copy link
Copy Markdown
Member

@stevhliu stevhliu left a comment

Choose a reason for hiding this comment

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

very nice!

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

@sayakpaul
Copy link
Copy Markdown
Member Author

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
Copy link
Copy Markdown
Member

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

@sayakpaul
Copy link
Copy Markdown
Member Author

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?

@sayakpaul sayakpaul marked this pull request as ready for review May 20, 2026 06:35
@sayakpaul sayakpaul requested review from DN6, stevhliu and yiyixuxu May 20, 2026 06:35
@HuggingFaceDocBuilderDev
Copy link
Copy Markdown

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants