Update xhydro/testing/utils.py

Co-authored-by: Trevor James Smith <10819524+Zeitsperre@users.noreply.github.com>
hydrologie · Oct 12, 2023 · 221c160 · 221c160
1 parent f1888a3
commit 221c160
Showing 1 changed file with 4 additions and 4 deletions.
diff --git a/xhydro/testing/utils.py b/xhydro/testing/utils.py
@@ -14,10 +14,10 @@ def publish_release_notes(
 
     Parameters
     ----------
-    style: {"rst", "md"}
-      Use ReStructuredText formatting or Markdown. Default: Markdown.
-    file: {os.PathLike, StringIO, TextIO}, optional
-      If provided, prints to the given file-like object. Otherwise, returns a string.
+    style : {"rst", "md"}
+        Use ReStructuredText (`rst`) or Markdown (`md`) formatting. Default: Markdown.
+    file : {os.PathLike, StringIO, TextIO, None}
+        If provided, prints to the given file-like object. Otherwise, returns a string.
 
     Returns
     -------