docs: improve cli description

datagouv/commands/dataset.py

@@ -9,7 +9,7 @@
 
 @app.command()
 def display(id: str) -> None:
-    """Human-friendlily display a dataset's attributes."""
+    """Display the main attributes of a dataset in a human-friendly format. `id` required."""
     client = Client(**load_config())
     dataset = client.dataset(id)
     for att in dataset._attributes:
@@ -19,7 +19,7 @@ def display(id: str) -> None:
 
 @app.command()
 def get(id: str) -> None:
-    """Display a dataset's metadata in JSON."""
+    """Display all attributes of a dataset in JSON (title, description, resources, ...). `id` required."""
     client = Client(**load_config())
     dataset = client.dataset(id, fetch=False)
     display_json(dataset)
@@ -58,7 +58,7 @@ def update(
     id: str,
     set: list[str] = typer.Option([], "--set"),
 ) -> None:
-    """Update a dataset. Each `--set` option is expected as `<key>=<new_value>`."""
+    """Update a dataset by `id`. Each `--set` option is expected as `<key>=<new_value>`."""
     client = Client(**load_config())
     payload = {}
     for item in set:
@@ -83,7 +83,7 @@ def sort_resources(
 
 @app.command()
 def delete(id: str) -> None:
-    """Delete a dataset."""
+    """Delete a dataset by `id`."""
     client = Client(**load_config())
     client.dataset(id, fetch=False).delete()
     typer.echo("Dataset deleted successfully ✓")

datagouv/commands/organization.py

@@ -9,7 +9,7 @@
 
 @app.command()
 def display(id: str) -> None:
-    """Human-friendlily display an organization's attributes."""
+    """Display an organization's main attributes in a human-friendly format. `id` required."""
     client = Client(**load_config())
     orga = client.organization(id)
     for att in orga._attributes:
@@ -19,7 +19,7 @@ def display(id: str) -> None:
 
 @app.command()
 def get(id: str) -> None:
-    """Display an organization's metadata in JSON."""
+    """Display all of an organization's attributes in JSON. `id` required."""
     client = Client(**load_config())
     organization = client.organization(id, fetch=False)
     display_json(organization)
@@ -47,7 +47,7 @@ def update(
     id: str,
     set: list[str] = typer.Option([], "--set"),
 ) -> None:
-    """Update an organization. Each `--set` option is expected as `<key>=<new_value>`."""
+    """Update an organization by `id`. Each `--set` option is expected as `<key>=<new_value>`."""
     client = Client(**load_config())
     payload = {}
     for item in set:
@@ -60,7 +60,7 @@ def update(
 
 @app.command()
 def delete(id: str) -> None:
-    """Delete an organization."""
+    """Delete an organization by `id`."""
     client = Client(**load_config())
     client.organization(id, fetch=False).delete()
     typer.echo("Organization deleted successfully ✓")

datagouv/commands/resource.py

@@ -9,7 +9,7 @@
 
 @app.command()
 def display(id: str) -> None:
-    """Human-friendlily display a resource's attributes."""
+    """Display a resource's main attributes in a human-friendly format. `id` required."""
     client = Client(**load_config())
     resource = client.resource(id)
     for att in resource._attributes:
@@ -19,7 +19,7 @@ def display(id: str) -> None:
 
 @app.command()
 def get(id: str) -> None:
-    """Display a resource's metadata in JSON."""
+    """Display all of a resource's attributes in JSON (title, description, download URL, ...). `id` required."""
     client = Client(**load_config())
     resource = client.resource(id, fetch=False)
     display_json(resource)
@@ -62,7 +62,7 @@ def update(
     id: str,
     set: list[str] = typer.Option([], "--set"),
 ) -> None:
-    """Update a resource. Each `--set` option is expected as `<key>=<new_value>`."""
+    """Update a resource by `id`. Each `--set` option is expected as `<key>=<new_value>`."""
     client = Client(**load_config())
     payload = {}
     for item in set:
@@ -75,15 +75,15 @@ def update(
 
 @app.command()
 def download(id: str, path: str) -> None:
-    """Download a resource to a given path."""
+    """Download a resource by `id` to a given `path`."""
     client = Client(**load_config())
     client.resource(id).download(path)
     typer.echo(f"Resource downloaded successfully at {path} ✓")
 
 
 @app.command()
 def delete(id: str) -> None:
-    """Delete a resource."""
+    """Delete a resource by `id`."""
     client = Client(**load_config())
     client.resource(id, fetch=False).delete()
     typer.echo("Resource deleted successfully ✓")

datagouv/commands/topic.py

@@ -9,7 +9,7 @@
 
 @app.command()
 def display(id: str) -> None:
-    """Human-friendlily display a topic's attributes."""
+    """Display a topic's attributes in a human-friendly format. `id` required."""
     client = Client(**load_config())
     topic = client.topic(id)
     for att in topic._attributes:
@@ -19,7 +19,7 @@ def display(id: str) -> None:
 
 @app.command()
 def get(id: str) -> None:
-    """Display a topic's metadata in JSON."""
+    """Display all of a topic's attributes in JSON. `id` required."""
     client = Client(**load_config())
     topic = client.topic(id, fetch=False)
     display_json(topic)
@@ -57,7 +57,7 @@ def update(
     id: str,
     set: list[str] = typer.Option([], "--set"),
 ) -> None:
-    """Update a topic. Each `--set` option is expected as `<key>=<new_value>`."""
+    """Update a topic by `id`. Each `--set` option is expected as `<key>=<new_value>`."""
     client = Client(**load_config())
     payload = {}
     for item in set:
@@ -70,7 +70,7 @@ def update(
 
 @app.command()
 def delete(id: str) -> None:
-    """Delete a topic."""
+    """Delete a topic by `id`."""
     client = Client(**load_config())
     client.topic(id, fetch=False).delete()
     typer.echo("Topic deleted successfully ✓")