feat(cli): unified the display format of description in CLI

Graviti-AI · Jul 14, 2021 · 2ffdbde · 2ffdbde
1 parent 58fcf1d
commit 2ffdbde
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 13 deletions.
diff --git a/tensorbay/cli/commit.py b/tensorbay/cli/commit.py
@@ -12,7 +12,7 @@
 from .tbrn import TBRN, TBRNType
 from .utility import edit_message, error, format_hint, get_dataset_client, get_gas
 
-_COMMIT_HINT = """
+_COMMIT_HINT = """{}{}
 # Please enter the commit message for your changes.
 # The Default commit message is set as the draft title.
 # Lines starting with '#' will be ignored.

diff --git a/tensorbay/cli/draft.py b/tensorbay/cli/draft.py
@@ -15,7 +15,7 @@
 from .tbrn import TBRN, TBRNType
 from .utility import edit_message, error, format_hint, get_dataset_client, get_gas
 
-_DRAFT_HINT = """
+_DRAFT_HINT = """{}{}
 # Please enter the message for your draft.
 # Lines starting with '#' will be ignored.
 # And an empty draft message aborts the creation.
@@ -46,7 +46,7 @@ def _create_draft(dataset_client: DatasetClientType, info: TBRN, message: Tuple[
     if info.is_draft:
         error(f'Create a draft in draft status "{info}" is not permitted')
 
-    title, description = edit_message(message, _DRAFT_HINT)
+    title, description = edit_message(message, _DRAFT_HINT.format("", ""))
     if not title:
         error("Aborting creating draft due to empty draft message")
 
@@ -94,6 +94,7 @@ def _echo_draft(
         title = "<no title>"
     click.echo(f"\n    {title}\n")
     if description:
+        description = description.replace("\n", "\n    ")
         click.echo(f"    {description}\n")
 
 

diff --git a/tensorbay/cli/log.py b/tensorbay/cli/log.py
@@ -18,10 +18,7 @@
 Author: {}
 Date: {}
 
-    {}
-
-    {}
-
+    {}{}
 """
 
 
@@ -45,10 +42,13 @@ def _get_oneline_log(commit: Commit) -> str:
 
 
 def _get_full_log(commit: Commit) -> str:
+    description = commit.description
+    if description:
+        description = "\n".join(("", "    " + description.replace("\n", "\n    "), ""))
     return _FULL_LOG.format(
         commit.commit_id,
         commit.committer.name,
         datetime.fromtimestamp(commit.committer.date).strftime("%a %b %d %H:%M:%S %y"),
-        commit.title,
-        commit.description,
+        commit.title + "\n",
+        description,
     )
diff --git a/tensorbay/cli/utility.py b/tensorbay/cli/utility.py
@@ -321,11 +321,9 @@ def format_hint(title: str, description: str, original_hint: str) -> str:
         The complete hint message.
 
     """
-    hint: Tuple[str, ...] = (title,)
     if description:
-        hint += ("", description)
-    hint += (original_hint,)
-    return "\n".join(hint)
+        description = "\n".join(("", description, ""))
+    return original_hint.format(title + "\n", description)
 
 
 def edit_message(message: Tuple[str, ...], hint_message: str) -> Tuple[str, str]: