Skip to content

Missing one-sentence description of the methods when calling --help #96

Description

@stinebuu

I am missing documentation about what the different methods does. For instance las datasets -h gives:

usage: las datasets [-h] {create,list,get,update,delete,create-documents,get-documents} ...

positional arguments:
  {create,list,get,update,delete,create-documents,get-documents}

optional arguments:
  -h, --help            show this help message and exit

But I am missing a sentence about the theme/purpose of las datasets is. Similarly las datasets create -h does not give the main purpose of create:

usage: las datasets create [-h] [--description DESCRIPTION] [--name NAME] [--metadata METADATA]

optional arguments:
  -h, --help            show this help message and exit
  --description DESCRIPTION
  --name NAME
  --metadata METADATA   path to json file with whatever you need, maximum limit 4kB

Though it might be deduced from the name, it is not obvious to me that it needs to be called before las datasets create-documents.

A one-sentence description of each method would be very helpful.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

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