How to render class args?

[albertvillanova]

I am trying to make appear in the docs the class args for datasets.DatasetBuilder without success:

• Update builder docstring for deprecated/added arguments datasets#4429

I have tried:

• putting args in docstring at the class level and also at the __init__ method
• adding "all" to autodoc directive

I took as example transformers.Trainer: https://huggingface.co/docs/transformers/main/en/main_classes/trainer#transformers.Trainer

What should I do to make it work?
Thank you.

P.S.: I open an issue as I think this might be useful to other users as well.

[albertvillanova]

There was a parsing error due to missing arg type. This commit makes the arg appear: huggingface/datasets@da5edf6

Maybe we should support args without type and render them as well?

[mishig25]

I can work on it but we want to have types in their args all the time, no?
cc: @sgugger

[sgugger]

Yes I don't think we want to support args with no types (note that just an empty pair of parenthesis would work by the way). This was a syntax error IMO.

[albertvillanova]

What about *args and/or **kwargs? Normally, these have no types...

See:

• Format error with **kwargs in docstring #235

Further references:

• https://google.github.io/styleguide/pyguide.html#doc-function-args
• def module_level_function in https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html

[sgugger]

In the example you point out, a parenthesis is missing at the end of "(Optional datasets.DownloadConfig"

download_config (Optional ``datasets.DownloadConfig``: specific download configuration parameters.

which doesn't help.

As for kwargs, we always add something in Transformers like this:

**kwargs (additional keyword arguments):

or

kwargs (remaining dictionary of keyword arguments, *optional*):

or

kwargs (`Dict[str, Any]`, *optional*):

[albertvillanova]

Thanks @sgugger! 🤗