question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Sentences ending with code blocks

See original GitHub issue

Describe 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:closed
  • Created a year ago
  • Comments:24 (19 by maintainers)

github_iconTop GitHub Comments

2reactions
jeremyltcommented, May 19, 2022

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.

2reactions
ojeytonwilliamscommented, May 18, 2022

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.

Read more comments on GitHub >

github_iconTop Results From Across the Web

How to punctuate a sentence ending in a code block on Stack ...
1 · Just do the best you can, given the tools you have. · @HotLicks achewood.com/index.php? · Understand that the "rules" for punctuating...
Read more >
text - Code::Blocks
Editing files and debugging projects are two typical examples for such situations. Code::Blocks offers a mechanism for storing and selecting different ...
Read more >
Code Blocks – Programming Fundamentals - Rebus Press
A code block, sometimes referred to as a compound statement, is a lexical structure of source code which is grouped together. Blocks consist...
Read more >
What is the point/use in code blocks? (Example) - Treehouse
Code blocks { } are used to mark the start and end of a piece of code. ... blocks as the first capital...
Read more >
Code blocks with syntax highlighting - TYPO3 Documentation
In the past a simplified shorthand directive was widely used: A sentence ending with two double colon :: , followed by a new...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found