improve --tags docs

Signed-off-by: Tommy Hughes <tohughes@redhat.com>
feast-dev · Jun 17, 2024 · a49611f · a49611f
1 parent 681905c
commit a49611f
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 3 deletions.
diff --git a/docs/reference/feast-cli-commands.md b/docs/reference/feast-cli-commands.md
@@ -66,6 +66,10 @@ List all registered entities
 
 ```text
 feast entities list
+
+Options:
+  --tags TEXT  Filter by tags (e.g. --tags 'key:value' --tags 'key:value,
+               key:value, ...'). Items return when ALL tags match.
 ```
 
 ```text
@@ -79,11 +83,15 @@ List all registered feature views
 
 ```text
 feast feature-views list
+
+Options:
+  --tags TEXT  Filter by tags (e.g. --tags 'key:value' --tags 'key:value,
+               key:value, ...'). Items return when ALL tags match.
 ```
 
 ```text
-NAME                 ENTITIES
-driver_hourly_stats  ['driver_id']
+NAME                 ENTITIES    TYPE
+driver_hourly_stats  {'driver'}  FeatureView
 ```
 
 ## Init

diff --git a/sdk/python/feast/cli.py b/sdk/python/feast/cli.py
@@ -49,7 +49,7 @@
 _logger = logging.getLogger(__name__)
 tagsOption = click.option(
     "--tags",
-    help="Filter by tags (e.g. 'key:value, key:value, ...')",
+    help="Filter by tags (e.g. --tags 'key:value' --tags 'key:value, key:value, ...'). Items return when ALL tags match.",
     default=[""],
     multiple=True,
 )