Skip to content

Conversation

@albertvillanova
Copy link
Member

@albertvillanova albertvillanova commented May 31, 2022

This PR updates the builder docstring with deprecated/added directives for arguments name/config_name.

Follow up of:

First merge:

@albertvillanova albertvillanova changed the title Docstring builder Update builder docstring for deprecated/added arguments May 31, 2022
@HuggingFaceDocBuilderDev
Copy link

HuggingFaceDocBuilderDev commented May 31, 2022

The documentation is not available anymore as the PR was closed or merged.

@albertvillanova albertvillanova marked this pull request as draft June 1, 2022 14:15
@albertvillanova
Copy link
Member Author

albertvillanova commented Jun 3, 2022

@mishig25 is investigating why deprecated/added do not affect the enclosed text format when used in args docstring: no special formatting appears:

@mishig25
Copy link

mishig25 commented Jun 6, 2022

@albertvillanova
Copy link
Member Author

Thanks @mishig25.

Just one question: is it expected to have the deprecated box right edge not filling all the page width (contrary to the added box)?

@mishig25
Copy link

mishig25 commented Jun 8, 2022

Just one question: is it expected to have the deprecated box right edge not filling all the page width (contrary to the added box)?

Yes, that is expected 😊 because the depreacted box is being bounded by its parent box (the box for name argument in the screenshot above)

@albertvillanova albertvillanova marked this pull request as ready for review June 8, 2022 11:30
@albertvillanova albertvillanova merged commit 1fb11fb into huggingface:master Jun 8, 2022
@albertvillanova albertvillanova deleted the docstring-builder branch June 8, 2022 11:31
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.

3 participants