Fix number format starting over after a block of code #617
Conversation
…r fenced code blocks (triple backticks).
RobinBateman808
requested review from
0xTim,
alexandersandberg,
daveverwer,
dempseyatgithub,
parispittman,
kaishin,
shahmishal,
cthielen and
federicobucchi
as code owners
|
@0xTim - I manually inserted the next number in the numbered sequences (1, 2, 3, 4...) to avoid Markdown disrupting the sequential numbering of lists after triple backticks (as is, the numbering starts over when it shouldn't on the swift.org page). I also added an "Overview" for page consistency and reformatted the section subheads to improve the flow. |
|
Hi @0xTim - another friendly to check out the minor changes that should fix the numbering format issue. I appreciate your time and help! Thanks again. |
| @@ -78,7 +80,6 @@ To debug memory leaks using Valgrind, install it on your system. | |||
| 1. Open a Terminal session. | |||
| 2. [Install Homebrew](https://brew.sh/) if you haven't already. | |||
| 3. Once `Homebrew` is installed, run this command to install `valgrind`: | |||
|
|
|||
There was a problem hiding this comment.
I thought we needed these blank lines for the Jekyll markdown parser to pick up the code blocks? Did you try running the site to see if it still renders properly?
There was a problem hiding this comment.
Ack. I use macOS and get this error when trying to install valgrind:
"valgrind: Linux is required for this software. Error: valgrind: An unsatisfied requirement failed this build"
Should I remove the "macOS" option/instruction set since Linux is required to run valgrin? I'm new to Swift, so trying to figure this out as I go. I'm open to suggestions for accuracy and/or improvements (to help people like me).
There was a problem hiding this comment.
Ah sorry I meant running the website to see what the generated pages look like. The README for this repo has instructions on how to do that.
There was a problem hiding this comment.
But yes we should remove the macOS option here - valgrind won't run on macOS
There was a problem hiding this comment.
@0xTim - I removed the macOS option. If this all looks good to you, feel free to merge. Thanks Tim!
There was a problem hiding this comment.
@FranzBusch - Can you also PTAL for accuracy? Thanks!
There was a problem hiding this comment.
@RobinBateman808 there are several formatting issues with the removed newlines. If you run the site locally you'll spot them
| ``` | ||
| sudo apt-get install heaptrack | ||
| ``` | ||
|
|
||
| 2. Run the binary twice using `heaptrack`. The first run provides a baseline for `main`. | ||
|
|
There was a problem hiding this comment.
We need this, otherwise it breaks the formatting
There was a problem hiding this comment.
@0xTim -Apologies, I can't see the screenshot you added above (it just opens a new page for this PR when I click on it), so I don't understand your ask. Please feel free to suggest changes to the language or code that are needed for accuracy. Thanks!
I added spaces to nest the numbering sequences after the removal of macOS content for Valgrind.
There was a problem hiding this comment.
Hi @0xTim - Please ignore these commit changes and review the next one where I "reformatted bullets and numbering"
Added spaces between backticks and wording to align code formatting in the Heaptrack section.
There was a problem hiding this comment.
@0xTim - Changed numbering sequence to "steps" to correct formatting issues.
|
@swift-ci test |
Motivation:
Fix the sequential number list starting over after a block of code.
Modifications:
Manually override Markdown's handling of numbered lists.
Result:
Maintain the continuity of sequential numbering.