Skip to content

Commit

Permalink
docs: explain how to use boolean or list values (#186)
Browse files Browse the repository at this point in the history
* docs: explain how to use boolean or list values

* Update deepset_cloud_sdk/cli.py

Co-authored-by: Agnieszka Marzec <[email protected]>

---------

Co-authored-by: Agnieszka Marzec <[email protected]>
  • Loading branch information
ArzelaAscoIi and agnieszka-m authored May 6, 2024
1 parent 0f55cbf commit 334ed8c
Showing 1 changed file with 13 additions and 1 deletion.
14 changes: 13 additions & 1 deletion deepset_cloud_sdk/cli.py
Original file line number Diff line number Diff line change
Expand Up @@ -316,7 +316,19 @@ def main(
None, "--version", callback=version_callback, is_eager=True, help="Show the SDK version and exit."
)
) -> None: # noqa
"""The CLI for the deepset Cloud SDK."""
"""The CLI for the deepset Cloud SDK.
This documentation uses Python type hints to provide information about the arguments and return values.
Typer turns these type hints into a CLI interface. To see how these arguments are used in the CLI, check the
Typer documentation: https://typer.tiangolo.com/tutorial/arguments/optional or run
`deepset-cloud <command> --help` to see the arguments for a specific command.
Boolean values are converted to `-no-<variable>` or `-<variable>` flags in the CLI. For example, to disable
the progress bar, use `--no-show-progress`.
Lists can be passed by using the same flag multiple times. For example, to scan only `.txt` and `.pdf` files,
when uploading use `--use-type .txt --use-type .pdf`.
"""


def run_packaged() -> None:
Expand Down

0 comments on commit 334ed8c

Please sign in to comment.