Skip to content

Format error with **kwargs in docstring #235

@albertvillanova

Description

@albertvillanova

When a docstring contains the **kwargs in the Args list, it is not properly formatted: instead of its own line in the Parameters section, it is attached to the preceding arg, e.g. (see last line below): https://huggingface.co/docs/datasets/v2.1.0/en/package_reference/loading_methods#datasets.inspect_dataset

datasets.inspect_dataset( path: strlocal_path: strdownload_config: typing.Optional[datasets.utils.file_utils.DownloadConfig] = None, **download_kwargs )

Parameters:

  • path (str) — path to the dataset processing script with the dataset builder. Can be either:

    • a local path to processing script or the directory containing the script (if the script has the same name as the directory), e.g. './dataset/squad' or './dataset/squad/squad.py'
    • a dataset identifier on the Hugging Face Hub (list all available datasets and ids with datasets.list_datasets()) e.g. 'squad', 'glue' or 'openai/webtext'
  • local_path (str) — path to the local folder to copy the datset script to.

  • download_config (Optional datasets.DownloadConfig — specific download configuration parameters. **download_kwargs — optional attributes for DownloadConfig() which will override the attributes in download_config if supplied.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions