feat(formatting) allow empty string in result to imply code format #81
Conversation
There was a problem hiding this comment.
Hey again @ianhi, thanks for this other PR 🚀 I'm not entirely sold on the idea, as it's usually better to actually provide a language name. For code blocks without syntax highlighting, you'd typically use text. But given this change is very small, lets merge it.
| @@ -92,7 +92,7 @@ def base_format( | |||
| md: Markdown, | |||
| html: bool = False, | |||
| source: str = "", | |||
| result: str = "", | |||
| result: str = None, | |||
There was a problem hiding this comment.
| result: str = None, | |
| result: str | None = None, |
| result="", | ||
| md=md, | ||
| ) | ||
| assert "<code>" in markup |
There was a problem hiding this comment.
I feel like it should assert a bit more. Were you able to confirm the test didn't pass without the change?
Maybe a better change here is to add something to that effect to the documentation. If using "text" is pretty standard |
|
You're right, lets just document that then 🙂 You can update this PR or update a new one (or neither and I'll take care of it), as you wish 😄 |
Sometimes for formatting I found it preferable to have the output wrapped in a code block. In particular for when I had many python print statements. A hacky way to do this is to pass an invalid language name. e.g.
result="code"but that is not super intuitive. Passingresult=""was the first thing I tried to get the rendering to work properly so this PR offers that as an option. There is likely a better alternative, but I couldn't immediately think of it.(I didn't use
result="python"because that can give confusing syntax highlighting in the print statements.