Remove unnecessary whitespace from markdown-formatted help, and use the most appropriate quote type for inline code.

Author: domdfcoding

consolekit/commands.py

@@ -169,7 +169,7 @@ def format_help_text(self, ctx: click.Context, formatter: click.formatting.HelpF
 		doc = block_token.Document(self.help or '')
 
 		with TerminalRenderer() as renderer:
-			rendered_doc = indent(renderer.render(doc), "  ")
+			rendered_doc = indent(renderer.render(doc).strip(), "  ")
 
 		if resolve_color_default(self._colour) is False:
 			# Also remove 'COMBINING LONG STROKE OVERLAY', used for strikethrough.

consolekit/utils.py

@@ -382,7 +382,7 @@ def render_inline_code(self, token: span_token.InlineCode) -> str:
 		"""
 
 		# TODO: A better implementation
-		return f"'{self.render_inner(token)}'"
+		return f"{self.render_inner(token)!r}"
 
 	def render_strikethrough(self, token: span_token.Strikethrough) -> str:
 		"""

tests/test_commands.py

@@ -213,7 +213,7 @@ def test_markdown_help_command_pycharm(
 	runner = CliRunner()
 
 	result: Result = runner.invoke(markdown_demo_command, catch_exceptions=False, args=["--help"], color=True)
-	check_file_regression(result.stdout.rstrip(), file_regression)
+	check_file_regression(result.stdout.rstrip(), file_regression, extension=".md")
 
 
 def test_private_helpers(monkeypatch):

tests/test_commands_/test_markdown_help_command.txt

@@ -1,14 +1,11 @@
 Usage: demo [OPTIONS]
 
-
   This is the summary line.
 
   This program does the 'following':
    * This
    * That
    * T̶h̶e̶ ̶o̶t̶h̶e̶r̶ (deprecated)
 
-
-
 Options:
   -h, --help  Show this message and exit.

tests/test_commands_/test_markdown_help_command_no_colour.txt

@@ -1,15 +1,12 @@
 Usage: demo [OPTIONS]
 
-
   This is the summary line.
 
   This program does the 'following':
    1. This
    2. That
    3. The other (deprecated)
 
-
-
 Options:
   --colour / --no-colour  Whether to use coloured output.
   -h, --help              Show this message and exit.

tests/test_commands_/test_markdown_help_command_ordered_list.txt

@@ -1,14 +1,11 @@
 Usage: demo [OPTIONS]
 
-
   This is the summary line.
 
   This program does the 'following':
    1. This
    2. That
    3. T̶h̶e̶ ̶o̶t̶h̶e̶r̶ (deprecated)
 
-
-
 Options:
   -h, --help  Show this message and exit.

tests/test_commands_/test_markdown_help_command_pycharm.txt renamed to tests/test_commands_/test_markdown_help_command_pycharm.md

@@ -1,14 +1,11 @@
 Usage: demo [OPTIONS]
 
-
   This is the summary line.
 
   This program does 𝘵𝘩𝘦 'following':
    * This
    * That
    * The other (deprecated)
 
-
-
 Options:
   -h, --help  Show this message and exit.

tests/test_commands_/test_markdown_help_group_command.md

@@ -1,14 +1,11 @@
 Usage: foo [OPTIONS]
 
-
   This is the summary line.
 
   This program does the 'following':
    * This
    * That
    * T̶h̶e̶ ̶o̶t̶h̶e̶r̶ (deprecated)
 
-
-
 Options:
   --help  Show this message and exit.

tests/test_commands_/test_markdown_help_group_group.md

@@ -1,15 +1,12 @@
 Usage: demo [OPTIONS] COMMAND [ARGS]...
 
-
   This is the summary line.
 
   This program does the 'following':
    * This
    * That
    * T̶h̶e̶ ̶o̶t̶h̶e̶r̶ (deprecated)
 
-
-
 Options:
   -h, --help  Show this message and exit.