Welcome to Software Development on Codidact!
Will you help us build our independent community of developers helping developers? We're small and trying to grow. We welcome questions about all aspects of software development, from design to code to QA and more. Got questions? Got answers? Got code you'd like someone to review? Please join us.
Issue with the Monospace font [duplicate]
Closed as duplicate by Alexei on Mar 19, 2024 at 06:59
This question has been addressed elsewhere. See: The way I tried to mark up code did not work. What is the right way to do it?
This question was closed; new answers can no longer be added. Users with the reopen privilege may vote to reopen this question if it has been improved or closed incorrectly.
I was trying to ask a code review question but I have observed that it does not support the "Monospace font" for code excerpts properly. It is only considered partially and I see this particularly in Python. I mean to say that, whatever is present in the backticks is not recognized as code completely. Could you please look into this and fix it?
Below is an example for your reference.
`import re
Define the regex pattern
pattern = re.compile(r'abc\d+')
Open the file for reading
with open(r"filepath") as file:
# Initialize an empty list to store matching lines
matching_lines = []
# Read each line in the file
for line in file:
# Check if the line matches the regex pattern
if pattern.search(line):
# If it matches, add the line to the list
matching_lines.append(line.strip()) # strip() removes leading/trailing whitespace
Print the list of matching lines
print(matching_lines)`
1 answer
What's wrong
As Moshi's comment points out, single backticks only work for inline code (code that appears within a paragraph of other text, and contains no line breaks).
The following raw text:
A paragraph with `inline code` showing.
is rendered as:
A paragraph with
inline codeshowing.
However, adding a line break[1] stops the single backticks from being recognised as inline code. The following raw text:
A paragraph with `inline code` showing.
is not rendered as code:
A paragraph with `inline
code` showing.
How to fix it
In Markdown, a code block uses three or more backticks and allows line breaks for multiple lines of code. The following raw text:
``` Multiple lines of code now ```
renders as:
Multiple lines of code now
In nearly all cases you will only need 3 backticks. More can be used for those cases where you need to post a code block that itself contains 3 backticks. You can edit this post to see an example of 4 backticks for this reason.
In this particular case, you can also apply syntax highlighting by adding the name of the programming language on the same line as the opening backticks:
```python
for line in file:
print(line)
```
renders as:
for line in file:
print(line)
Why it only looked half wrong
If the code had simply failed to render as code anywhere, it might have been easier to see that the Markdown syntax was incorrect. However, as you noticed, part of the code was rendered correctly, which is confusing.
The reason for this is that there is an alternative method of indicating a code block in Markdown: text with 4 or more leading spaces is treated as code.
So the single backtick was ignored, due to having no closing backtick on the same line, but all of the code after the first level of indentation was displayed with code formatting.
-
Technically 2 line breaks are required to cause this problem, since in Markdown a single line break is converted to a space. In many code blocks double line breaks will be present, and in those with none the code block will still look incorrect as it will display on one line instead of several. ↩︎
0 comment threads
1 comment thread