Skip to content

[docstring] Fix docstring for speech-to-text config#26883

Merged
ydshieh merged 6 commits intohuggingface:mainfrom
R055A:docstring-speech-to-txt
Oct 20, 2023
Merged

[docstring] Fix docstring for speech-to-text config#26883
ydshieh merged 6 commits intohuggingface:mainfrom
R055A:docstring-speech-to-txt

Conversation

@R055A
Copy link
Contributor

@R055A R055A commented Oct 17, 2023

What does this PR do?

Fixes #26638

Fix doc string for speech-to-text configuration.

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?
  • 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.

@R055A
Copy link
Contributor Author

R055A commented Oct 17, 2023

@ydshieh did the PR fail checks because any line(s) being beyond a 119-char limit?

@ArthurZucker
Copy link
Collaborator

ArthurZucker commented Oct 18, 2023

Yes, you should run make style to apply our styling to the code ! this will need the pip install -e ".[quality]" flags to make sure you have the required packages

@R055A
Copy link
Contributor Author

R055A commented Oct 18, 2023

Yes, you should run make style to apply our styling to the code ! this will need the pip install -e ".[quality]" flags to make sure you have the required packages

Thank you @ArthurZucker for the help. I have run make style as well as black .\configuration_speech_to_text.py and ruff .\configuration_speech_to_text.py. In each case, the file in this PR passes. I have shortened lines in the doc to ensure they do not exceed the 119-char limit but this has not resolved the code quality issue in the PR checks. It is difficult to determine the issue from this error

@R055A
Copy link
Contributor Author

R055A commented Oct 18, 2023 •
edited
Loading

Commit 13b0ad2 is the result from running: python utils/check_docstrings.py --fix_and_overwrite following removing Speech2TextConfig from OBJECTS_TO_IGNORE

@ydshieh
Copy link
Collaborator

ydshieh commented Oct 19, 2023 •
edited
Loading

ach case, the file in this PR passes. I have shortened lines in t

Hi @R055A

Could you run doc-builder style src/transformers docs/source --max_len 119 --path_to_docs docs/source

Make sure you have installed pip install hf-doc-builder

@R055A
Copy link
Contributor Author

R055A commented Oct 19, 2023

ach case, the file in this PR passes. I have shortened lines in t

Hi @R055A

Could you run doc-builder style src/transformers docs/source --max_len 119 --path_to_docs docs/source

Make sure you have installed pip install hf-doc-builder

Done. Thank you @ydshieh

ydshieh
ydshieh reviewed Oct 19, 2023
View reviewed changes
Copy link
Collaborator

@ydshieh ydshieh left a comment

Choose a reason for hiding this comment

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

Thank you. Just a few (very) tiny suggestion and we are ready to merge!

@R055A
Copy link
Contributor Author

R055A commented Oct 19, 2023

Thank you. Just a few (very) tiny suggestion and we are ready to merge!

Done, Thank you @ydshieh

@R055A R055A requested a review from ydshieh October 19, 2023 21:17
@HuggingFaceDocBuilderDev
Copy link

HuggingFaceDocBuilderDev commented Oct 20, 2023

The docs for this PR live here. All of your documentation changes will be reflected on that endpoint.

@ydshieh
Copy link
Collaborator

ydshieh commented Oct 20, 2023

Thank you @R055A for the contribution 🤗 ~

@ydshieh ydshieh merged commit 929134b into huggingface:main Oct 20, 2023
@R055A R055A deleted the docstring-speech-to-txt branch October 20, 2023 20:32
EduardoPach pushed a commit to EduardoPach/transformers that referenced this pull request Nov 19, 2023
@R055A @EduardoPach
[docstring] Fix docstring for speech-to-text config (huggingface#26883)
82cc9d0 
* Fix docstring for speech-to-text config

* Refactor doc line len <= 119 char

* Remove Speech2TextConfig from OBJECTS_TO_IGNORE

* Fix Speech2TextConfig doc str

* Fix Speech2TextConfig doc using doc-builder

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

Reviewers

@ydshieh ydshieh ydshieh approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

[Community Event] Docstring Sprint

4 participants

@R055A @ArthurZucker @ydshieh @HuggingFaceDocBuilderDev