From d0afc22c80eaf484099e48bcbe290276234295dc Mon Sep 17 00:00:00 2001
From: Synchon Mandal <synchon@protonmail.com>
Date: Tue, 15 Nov 2022 10:24:46 +0100
Subject: [PATCH 1/2] fix: add \f in cli.py docstrings to allow click to
 truncate text after that

---
 junifer/api/cli.py | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)

diff --git a/junifer/api/cli.py b/junifer/api/cli.py
index 0f25d5ecd..1f146736a 100644
--- a/junifer/api/cli.py
+++ b/junifer/api/cli.py
@@ -84,7 +84,7 @@ def cli() -> None:  # pragma: no cover
 )
 def run(filepath: click.Path, element: str, verbose: click.Choice) -> None:
     """Run command for CLI.
-
+    \f
     Parameters
     ----------
     filepath : click.Path
@@ -128,7 +128,7 @@ def run(filepath: click.Path, element: str, verbose: click.Choice) -> None:
 )
 def collect(filepath: click.Path, verbose: click.Choice) -> None:
     """Collect command for CLI.
-
+    \f
     Parameters
     ----------
     filepath : click.Path
@@ -169,7 +169,7 @@ def queue(
     verbose: click.Choice,
 ) -> None:
     """Queue command for CLI.
-
+    \f
     Parameters
     ----------
     filepath : click.Path
@@ -204,7 +204,7 @@ def queue(
 @click.option("--long", "long_", is_flag=True)
 def wtf(long_: bool) -> None:
     """Wtf command for CLI.
-
+    \f
     Parameters
     ----------
     long_ : bool
@@ -225,7 +225,7 @@ def wtf(long_: bool) -> None:
 @click.argument("subpkg", type=str)
 def selftest(subpkg: str) -> None:
     """Selftest command for CLI.
-
+    \f
     Parameters
     ----------
     subpkg : {"all", "api", "configs", "data", "datagrabber", "datareader",
-- 
2.52.0


From 920b3dfdfc6a57a28bd1f2a575d0914eeb835aa0 Mon Sep 17 00:00:00 2001
From: Synchon Mandal <synchon@protonmail.com>
Date: Tue, 15 Nov 2022 10:25:28 +0100
Subject: [PATCH 2/2] update: ignore D301 to allow \f in docstrings for click

---
 tox.ini | 1 +
 1 file changed, 1 insertion(+)

diff --git a/tox.ini b/tox.ini
index f4a6f3e17..a922c8c8e 100644
--- a/tox.ini
+++ b/tox.ini
@@ -96,6 +96,7 @@ extend-ignore =
     B024  # abstract class with no abstract methods
     D202
     D107  # missing docstring in __init__, incompatible with numpydoc
+    D301  # use r""" if any backslashes in a docstring
     E201  # whitespace after ‘(’
     E202  # whitespace before ‘)’
     E203  # whitespace before ‘,’, ‘;’, or ‘:’
-- 
2.52.0