diffusers icon indicating copy to clipboard operation
diffusers copied to clipboard

[docs] refactoring docstrings in ./src/diffusers/models/transformers/auraflow_transformer_2d.py

Open ahnjj opened this issue 1 year ago • 1 comments

What does this PR do?

Fixes https://github.com/huggingface/diffusers/issues/9567

(I reopened PR with same doc since my previous PR may occur sync issue. sorry for confusion!)

Fixes # (issue)

  • Unified two expressions with the same meaning into one. (arguments / parameters -> args)
  • Concise Summary and argument descriptions
  • Corrected Grammar

Before submitting

  • [x] This PR fixes a typo or improves the docs (you can dismiss the other checks if that's the case).
  • [x] Did you read the contributor guideline?
  • [x] Did you read our philosophy doc (important for complex PRs)?
  • [x] Was this discussed/approved via a GitHub issue or the forum? Please add a link to it if that's the case.
  • [ ] Did you make sure to update the documentation with your changes? Here are the documentation guidelines, and here are tips on formatting docstrings.
  • [ ] Did you write any new necessary tests?

Who can review?

This PR tries to attempt a solution at one of the submodules listed in https://github.com/huggingface/diffusers/issues/9567 so I think @a-r-r-o-w is the best to review it. Alongside the same, @charchit7 @yijun-lee and @SubhasmitaSw were also working on the same, so just a ping for the update on the same.

ahnjj avatar Oct 19 '24 05:10 ahnjj

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.

This issue has been automatically marked as stale because it has not had recent activity. If you think this still needs to be addressed please comment on this thread.

Please note that issues that do not follow the contributing guidelines are likely to be ignored.

github-actions[bot] avatar Nov 18 '24 15:11 github-actions[bot]

Gentle ping to run make fix-copies and make style @ahnjj. This looks good to merge after that, thank you for your contributions!

a-r-r-o-w avatar Nov 18 '24 20:11 a-r-r-o-w

This issue has been automatically marked as stale because it has not had recent activity. If you think this still needs to be addressed please comment on this thread.

Please note that issues that do not follow the contributing guidelines are likely to be ignored.

github-actions[bot] avatar Dec 22 '24 15:12 github-actions[bot]