Skip to content

[docs] Follow ups for consistent forward docstrings#13779

Draft
sayakpaul wants to merge 2 commits into
mainfrom
follow-ups-consistent-forward-docstrings
Draft

[docs] Follow ups for consistent forward docstrings#13779
sayakpaul wants to merge 2 commits into
mainfrom
follow-ups-consistent-forward-docstrings

Conversation

@sayakpaul
Copy link
Copy Markdown
Member

What does this PR do?

Follow ups from #13758 that added utilities in our CI to enforce some consistency in the forward() and call() methods of XXXModel and XXXPipeline classes, respectively. This PR:

  • allows the docstring checker to remove unused args in docstrings
  • checks for missing return types and reports them

I didn't implement placeholders because they tend to go unnoticed over time.

There will be some failures in our current CI because some classes don't document return types properly. We will fix those in a PR basing off of this branch. @stevhliu could you look into that?

@github-actions github-actions Bot added the size/L PR with diff > 200 LOC label May 21, 2026
@sayakpaul sayakpaul marked this pull request as draft May 21, 2026 03:57
@sayakpaul sayakpaul requested review from stevhliu and yiyixuxu May 21, 2026 03:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size/L PR with diff > 200 LOC

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant