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

fixed docstring typos #18739

Merged
merged 2 commits into from
Aug 24, 2022

Conversation

JadeKim042386
Copy link
Contributor

@JadeKim042386 JadeKim042386 commented Aug 23, 2022

What does this PR do?

Fixes # (#18721)

Before submitting

@ydshieh

@ydshieh
Copy link
Collaborator

ydshieh commented Aug 23, 2022

Hi, @JadeKim042386 . I am sorry that I was wrong - the 35 files changes comes from the fact you fixed more occurrences rather than just the initial ones!

I will review this PR now.

@HuggingFaceDocBuilderDev

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

@ydshieh
Copy link
Collaborator

ydshieh commented Aug 23, 2022

LGTM, but the change

from

kwargs: (*optional*) Remaining dictionary ...

to

kwargs (*optional*) Remaining dictionary ...

should be

kwargs (*optional*): Remaining dictionary ...

in my opinion. WDYT?

@JadeKim042386
Copy link
Contributor Author

@ydshieh
Oh, the colon was missing!
I think it would be better to put a colon~

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.

LGTM, thanks, @JadeKim042386 ! Will wait another reviewer to double check.

@ydshieh ydshieh requested a review from LysandreJik August 23, 2022 15:57
@ydshieh
Copy link
Collaborator

ydshieh commented Aug 23, 2022

@LysandreJik The number of changed files is large, but it just removes the extra : from some docstrings.

change

encoder_layerdrop: (`float`, *optional*, defaults to 0.0):

to

encoder_layerdrop (`float`, *optional*, defaults to 0.0):

I checked on the documentation page, and indeed there are missing arguments due to this fact.

Copy link
Member

@LysandreJik LysandreJik left a comment

Choose a reason for hiding this comment

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

Wow, very nice! Thanks for helping out on this @JadeKim042386, this is very appreciated!

@LysandreJik LysandreJik merged commit dcff504 into huggingface:main Aug 24, 2022
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