Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improves formatting of docstring + newlines #2006

Merged
merged 13 commits into from
Sep 9, 2024

Conversation

northern-64bit
Copy link
Contributor

What does this PR do?

Improve docstrings and kind of standardize them (allowing some variations). It further also makes sure that there is 2 empty rows after and before classes or functions (if they are not a part of a class), and otherwise not.

Before submitting

  • This PR fixes a typo or improves the docs (you can dismiss the other checks if that's the case).
  • Did you read the contributor guideline,
    Pull Request section?

Who can review?

Anyone in the community is free to review the PR once the tests have passed. Feel free to tag
members/contributors who may be interested in your PR.

@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.

@kashif
Copy link
Collaborator

kashif commented Sep 4, 2024

@northern-64bit there might be some potential merge conflicts when #1944 is merged

@northern-64bit
Copy link
Contributor Author

@northern-64bit there might be some potential merge conflicts when #1944 is merged

Thanks for letting me know. I've now fixed it.

@qgallouedec
Copy link
Member

Thanks a lot for cleaning the doc! Please address my comment and we're ready to merge :)

trl/trainer/utils.py Outdated Show resolved Hide resolved
trl/trainer/utils.py Outdated Show resolved Hide resolved
trl/trainer/utils.py Outdated Show resolved Hide resolved
trl/trainer/alignprop_trainer.py Outdated Show resolved Hide resolved
@qgallouedec qgallouedec merged commit a638f73 into huggingface:main Sep 9, 2024
9 checks passed
@northern-64bit northern-64bit deleted the improve_formatting branch September 9, 2024 17:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants