docs: update docs about "--show-drafts" option of "gas log" command

PR Closed: #1161
Graviti-AI · Dec 15, 2021 · 679b70b · 679b70b
1 parent 66c5ab8
commit 679b70b
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 1 deletion.
diff --git a/docs/source/tensorbay_cli/cli_commands.rst b/docs/source/tensorbay_cli/cli_commands.rst
@@ -338,6 +338,12 @@ Show graphical commit logs.
 
    $ gas log --graph tb:<dataset_name>
 
+Show commit and open draft logs.
+
+.. code:: html
+
+   $ gas log --show-drafts tb:<dataset_name>
+
 
 *************
  gas branch

diff --git a/tensorbay/cli/cli.py b/tensorbay/cli/cli.py
@@ -372,6 +372,7 @@ def tag(obj: ContextInfo, tbrn: str, name: str, is_delete: bool, sort: str) -> N
         "",
         "# Show text-based graphical commit logs.",
         "$ gas log --graph tb:<dataset_name>[@<revision>]",
+        "",
         "# Show commit and open draft logs.",
         "$ gas log --show-drafts tb:<dataset_name>[@<revision>]",
         "",
@@ -384,7 +385,7 @@ def tag(obj: ContextInfo, tbrn: str, name: str, is_delete: bool, sort: str) -> N
 @click.option("--oneline", is_flag=True, help="Limit commit message to oneline")
 @click.option("--all", "is_all", is_flag=True, help="Show all the commits of all branches")
 @click.option("--graph", is_flag=True, help="Show text-based graphical commits history")
-@click.option("--show-drafts", is_flag=True, help="Show open drafts")
+@click.option("--show-drafts", is_flag=True, help="Show open drafts along with the commits")
 @click.pass_obj
 def log(  # pylint: disable=too-many-arguments
     obj: ContextInfo,