Skip to content

Commit 679b70b

Browse files
Lee-000linjiX
authored andcommitted
docs: update docs about "--show-drafts" option of "gas log" command
PR Closed: #1161
1 parent 66c5ab8 commit 679b70b

File tree

2 files changed

+8
-1
lines changed

2 files changed

+8
-1
lines changed

docs/source/tensorbay_cli/cli_commands.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -338,6 +338,12 @@ Show graphical commit logs.
338338

339339
$ gas log --graph tb:<dataset_name>
340340

341+
Show commit and open draft logs.
342+
343+
.. code:: html
344+
345+
$ gas log --show-drafts tb:<dataset_name>
346+
341347

342348
*************
343349
gas branch

tensorbay/cli/cli.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -372,6 +372,7 @@ def tag(obj: ContextInfo, tbrn: str, name: str, is_delete: bool, sort: str) -> N
372372
"",
373373
"# Show text-based graphical commit logs.",
374374
"$ gas log --graph tb:<dataset_name>[@<revision>]",
375+
"",
375376
"# Show commit and open draft logs.",
376377
"$ gas log --show-drafts tb:<dataset_name>[@<revision>]",
377378
"",
@@ -384,7 +385,7 @@ def tag(obj: ContextInfo, tbrn: str, name: str, is_delete: bool, sort: str) -> N
384385
@click.option("--oneline", is_flag=True, help="Limit commit message to oneline")
385386
@click.option("--all", "is_all", is_flag=True, help="Show all the commits of all branches")
386387
@click.option("--graph", is_flag=True, help="Show text-based graphical commits history")
387-
@click.option("--show-drafts", is_flag=True, help="Show open drafts")
388+
@click.option("--show-drafts", is_flag=True, help="Show open drafts along with the commits")
388389
@click.pass_obj
389390
def log( # pylint: disable=too-many-arguments
390391
obj: ContextInfo,

0 commit comments

Comments
 (0)