From 6a6cff4821d9f9ee706f932efdd8e403a7f26f79 Mon Sep 17 00:00:00 2001 From: Jinzhe Zeng Date: Sat, 6 Apr 2024 00:04:05 -0400 Subject: [PATCH 1/6] fix(nb): do not wrap linebreak/indent into the code block Signed-off-by: Jinzhe Zeng --- dargs/notebook.py | 2 +- dargs/sphinx.py | 1 + docs/nb.ipynb | 5 +++++ 3 files changed, 7 insertions(+), 1 deletion(-) diff --git a/dargs/notebook.py b/dargs/notebook.py index 30b9708..8a17a78 100644 --- a/dargs/notebook.py +++ b/dargs/notebook.py @@ -298,7 +298,7 @@ def print_html(self, _level=0, _last_one=True): else: buff.append(r"""""") buff.append( - json.dumps(self.data, indent=2).replace("\n", f"{linebreak}{indent}") + json.dumps(self.data, indent=2).replace("\n", f"""{linebreak}{indent}""") ) if not _last_one: buff.append(",") diff --git a/dargs/sphinx.py b/dargs/sphinx.py index 5fe46e2..33772ee 100644 --- a/dargs/sphinx.py +++ b/dargs/sphinx.py @@ -171,6 +171,7 @@ def _test_argument() -> Argument: doc=doc_test, sub_fields=[ Argument("test_argument", dtype=str, doc=doc_test, default="test"), + Argument("test_list", type=List[int], optional=True), ], sub_variants=[ Variant( diff --git a/docs/nb.ipynb b/docs/nb.ipynb index 1793515..4b3d844 100644 --- a/docs/nb.ipynb +++ b/docs/nb.ipynb @@ -21,6 +21,11 @@ "jstr = \"\"\"\n", "{\n", " \"test_argument\": \"test1\",\n", + " \"test_list\": [\n", + " 1,\n", + " 2,\n", + " 3\n", + " ],\n", " \"test_variant\": \"test_variant_argument\",\n", " \"test_repeat\": [\n", " {\"test_repeat_item\": false},\n", From 08f88dc8b0746ad6e8d3b96d72437f3d762cb481 Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Sat, 6 Apr 2024 04:04:19 +0000 Subject: [PATCH 2/6] [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --- dargs/notebook.py | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/dargs/notebook.py b/dargs/notebook.py index 8a17a78..955b83d 100644 --- a/dargs/notebook.py +++ b/dargs/notebook.py @@ -298,7 +298,9 @@ def print_html(self, _level=0, _last_one=True): else: buff.append(r"""""") buff.append( - json.dumps(self.data, indent=2).replace("\n", f"""{linebreak}{indent}""") + json.dumps(self.data, indent=2).replace( + "\n", f"""{linebreak}{indent}""" + ) ) if not _last_one: buff.append(",") From 2cd69db39400674ea55b22621ce9bab9601d59c4 Mon Sep 17 00:00:00 2001 From: Jinzhe Zeng Date: Sat, 6 Apr 2024 00:05:44 -0400 Subject: [PATCH 3/6] fix typo Signed-off-by: Jinzhe Zeng --- dargs/sphinx.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/dargs/sphinx.py b/dargs/sphinx.py index 33772ee..4e61770 100644 --- a/dargs/sphinx.py +++ b/dargs/sphinx.py @@ -171,7 +171,7 @@ def _test_argument() -> Argument: doc=doc_test, sub_fields=[ Argument("test_argument", dtype=str, doc=doc_test, default="test"), - Argument("test_list", type=List[int], optional=True), + Argument("test_list", dtype=List[int], optional=True), ], sub_variants=[ Variant( From 45c7b50095d0e70bc6aad314266940725a9ce0ba Mon Sep 17 00:00:00 2001 From: Jinzhe Zeng Date: Sat, 6 Apr 2024 00:10:07 -0400 Subject: [PATCH 4/6] replace space Signed-off-by: Jinzhe Zeng --- dargs/notebook.py | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/dargs/notebook.py b/dargs/notebook.py index 955b83d..56a7583 100644 --- a/dargs/notebook.py +++ b/dargs/notebook.py @@ -298,9 +298,11 @@ def print_html(self, _level=0, _last_one=True): else: buff.append(r"""""") buff.append( - json.dumps(self.data, indent=2).replace( + json.dumps(self.data, indent=2) + .replace( "\n", f"""{linebreak}{indent}""" ) + .replace(" ", " ") ) if not _last_one: buff.append(",") From 5a5e280ae0d5358610ce8788a16a92a61c099db4 Mon Sep 17 00:00:00 2001 From: Jinzhe Zeng Date: Sat, 6 Apr 2024 00:11:21 -0400 Subject: [PATCH 5/6] Revert "replace space" This reverts commit 45c7b50095d0e70bc6aad314266940725a9ce0ba. --- dargs/notebook.py | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/dargs/notebook.py b/dargs/notebook.py index 56a7583..955b83d 100644 --- a/dargs/notebook.py +++ b/dargs/notebook.py @@ -298,11 +298,9 @@ def print_html(self, _level=0, _last_one=True): else: buff.append(r"""""") buff.append( - json.dumps(self.data, indent=2) - .replace( + json.dumps(self.data, indent=2).replace( "\n", f"""{linebreak}{indent}""" ) - .replace(" ", " ") ) if not _last_one: buff.append(",") From 6a29fdfa27bfea8c0d8e5e83cfbea11badb5e535 Mon Sep 17 00:00:00 2001 From: Jinzhe Zeng Date: Sat, 6 Apr 2024 00:13:01 -0400 Subject: [PATCH 6/6] first replace space Signed-off-by: Jinzhe Zeng --- dargs/notebook.py | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/dargs/notebook.py b/dargs/notebook.py index 955b83d..b69b31b 100644 --- a/dargs/notebook.py +++ b/dargs/notebook.py @@ -298,7 +298,9 @@ def print_html(self, _level=0, _last_one=True): else: buff.append(r"""""") buff.append( - json.dumps(self.data, indent=2).replace( + json.dumps(self.data, indent=2) + .replace(" ", " ") + .replace( "\n", f"""{linebreak}{indent}""" ) )