Sentences ending with code blocks
See original GitHub issueDescribe the Issue
Sentences ending with code blocks are confusing a noticeable portion of users.
For instance,
Add a comment above the p element with the text
TODO: Add link to cat photos
.
some users are expecting the . to be part of the required text while the tests will not pass with the . as part of the comment text.
Affected Page
Just looking at the first 15 challenges: https://www.freecodecamp.org/learn/2022/responsive-web-design/learn-html-by-building-a-cat-photo-app/step-2 https://www.freecodecamp.org/learn/2022/responsive-web-design/learn-html-by-building-a-cat-photo-app/step-4 https://www.freecodecamp.org/learn/2022/responsive-web-design/learn-html-by-building-a-cat-photo-app/step-8 https://www.freecodecamp.org/learn/2022/responsive-web-design/learn-html-by-building-a-cat-photo-app/step-9
Here the period is part of the text: https://www.freecodecamp.org/learn/2022/responsive-web-design/learn-html-by-building-a-cat-photo-app/step-3
This is going to touch a lot of challenges…
Your code
N/A
Expected behavior
Sentences should not end with code blocks. This will take some time, but someone should tweak the grammar in these new challenges to avoid ending sentences with code blocks where able.
Screenshots
No response
System
All
Additional context
No response
Issue Analytics
- State:
- Created a year ago
- Comments:24 (19 by maintainers)
Top GitHub Comments
Woops, dropping my phone accidentally pushed a button.
I personally wasn’t thinking of every code tag but rather lengthy verbatem blocks like urls, required strings, that sort of thing. Sort of how you see it in math textbooks where short things go inline and long things go on a separate line.
To ease the burden on translators, it would be good to separate the code block into its own paragraph. If we just tweak the grammar, that may only fix the English.