Use backticks for formatting

Author: hugovk

src/blurb/_add.py

@@ -24,15 +24,15 @@
 
 
 def add(*, issue: str | None = None, section: str | None = None):
-    """Add a blurb (a Misc/NEWS.d/next entry) to the current CPython repo.
+    """Add a blurb (a `Misc/NEWS.d/next` entry) to the current CPython repo.
 
-    Use -i/--issue to specify a GitHub issue number or link, e.g.:
+    Use `-i`/`--issue` to specify a GitHub issue number or link, e.g.:
 
         blurb add -i 12345
         # or
         blurb add -i https://github.com/python/cpython/issues/12345
 
-    Use -s/--section to specify the section name (case-insensitive), e.g.:
+    Use `-s`/`--section` to specify the section name (case-insensitive), e.g.:
 
         blurb add -s Library
         # or

src/blurb/_cli.py

@@ -39,8 +39,8 @@ def build_parser() -> argparse.ArgumentParser:
 
     parser = argparse.ArgumentParser(
         prog='blurb',
-        description='Management tool for CPython Misc/NEWS and Misc/NEWS.d entries.',
-        epilog="If blurb is run without any arguments, this is equivalent to 'blurb add'.",
+        description='Management tool for CPython `Misc/NEWS` and `Misc/NEWS.d` entries.',
+        epilog='If blurb is run without any arguments, this is equivalent to `blurb add`.',
     )
     parser.add_argument(
         '-V',

src/blurb/_merge.py

@@ -14,13 +14,13 @@
 
 
 def merge(output: str | None = None, *, forced: bool = False) -> None:
-    """Merge all blurbs together into a single Misc/NEWS file.
+    """Merge all blurbs together into a single `Misc/NEWS` file.
 
     Optional output argument specifies where to write to.
-    Default is <cpython-root>/Misc/NEWS.
+    Default is `<cpython-root>/Misc/NEWS`.
 
     If overwriting, blurb merge will prompt you to make sure it's okay.
-    To force it to overwrite, use -f.
+    To force it to overwrite, use `-f`.
     """
     if output:
         output = os.path.join(original_dir, output)

src/blurb/_populate.py

@@ -7,7 +7,7 @@
 
 
 def populate() -> None:
-    """Creates and populates the Misc/NEWS.d directory tree."""
+    """Creates and populates the `Misc/NEWS.d` directory tree."""
     os.chdir('Misc')
     os.makedirs('NEWS.d/next', exist_ok=True)