Fix docstring formatting issues causing Sphinx autodoc warnings

[kurtmckee]

What does this PR do?

Note

This was handwritten and tested by me, a human (I read your CONTRIBUTING doc.)

Tagging @tomaarsen, as this is related to doc build fixes I'm doing in the huggingface/sentence-transformers repo that he's been reviewing.

These formatting problems appear as warnings when building the huggingface/sentence-transformers docs. That project uses the TrainingArguments class and uses the autodoc Sphinx extension for doc builds, which subsequently throws the warnings about the docstring.

Here is a representative warning:

sentence_transformers/base/training_args.py:
docstring of transformers.training_args.TrainingArguments.set_push_to_hub:20:
WARNING: Bullet list ends without a blank line; unexpected unindent. [docutils]

This commit is a whitespace-only fix. It was tested against the huggingface/sentence-transformers docs builds to confirm that the warnings in that project were resolved.

Code Agent Policy

The Transformers repo is currently being overwhelmed by a large number of PRs and issue comments written by
code agents. We are currently bottlenecked by our ability to review and respond to them. As a result,
we ask that new users do not submit pure code agent PRs at this time.
You may use code agents in drafting or to help you diagnose issues. We'd also ask autonomous "OpenClaw"-like agents
not to open any PRs or issues for the moment.

PRs that appear to be fully agent-written will probably be closed without review, and we may block users who do this
repeatedly or maliciously.

This is a rapidly-evolving situation that's causing significant shockwaves in the open-source community. As a result,
this policy is likely to be updated regularly in the near future. For more information, please read CONTRIBUTING.md.

• I confirm that this is not a pure code agent PR.

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?
  ☝️ NOTE: I DO NOT SEE THAT SECTION IN THE CONTRIBUTING DOC! THIS LINK MAY BE OUTDATED!
• 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?

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.

[github-actions]

CI Dashboard: View test results in Grafana

[tomaarsen]

As a bit of extra context for transformers reviewers, Sentence Transformers inherits a lot of docstrings from transformers, but ST uses Sphinx instead of hf-doc-builder, and Sphinx its rST is a bit stricter with indentation. So it benefits ST if transformers fixes these small docstring quirks.

(The docs for this PR haven't built yet, so I'm actually not sure if hf-doc-builder handles these correctly or if it was also broken there)

cc @stevhliu

• Tom Aarsen

[stevhliu]

thanks, i think the changes should be ok! here's what a local build looks like for me with your changes:

[tomaarsen]

Thanks for the merge! P.s. I thought there used to be an automatic docs build for every PR, do we not do that anymore?

• Tom Aarsen

[stevhliu]

we still do that, but i think for this PR, there was a token issue so the bot couldn't post a comment with the preview link