Reformatted debug mem leak doc #608
Conversation
RobinBateman808
requested review from
0xTim,
alexandersandberg,
cthielen,
daveverwer,
dempseyatgithub,
federicobucchi,
kaishin,
parispittman and
shahmishal
as code owners
|
@0xTim - Here's the corrected PR. Apologies for the other and causing any confusion. No content changes were made, only syntax to correct the flow of information on the page. |
| } | ||
| myFunctionDoingTheAllocation() | ||
There was a problem hiding this comment.
Are these linebreaks at the bottom of the codeblocks required (the ones inside as opposed to outside) - doesn't that just add an extra line to all code blocks?
There was a problem hiding this comment.
Yes. I reverted the syntax (the extra spaces were initially there). I also removed characters that I suspect threw the formatting off and bolded "Notes" and "Tips". I tightened up the extra spaces yesterday, but the GitHub "preview" isn't always rendering how it actually displays on the published web page. So, hoping these changes will take care of it so no further changes are needed. My apologies for the extra cycle.
There was a problem hiding this comment.
@RobinBateman808 I removed the extra line breaks at the bottom of the code blocks as they were adding extra whitespace and weren't needed. You should be able to run the website locally following the README instructions - just checked and it's rendering fine now
RobinBateman808
changed the title
Removed spacing for a numbered bullet set to remove formatting as a code block.
|
@swift-ci please test |
* Reformatted and added spaces before backticks to correct content alignment. * Update memory-leaks-and-usage.md Removed spacing for a numbered bullet set to remove formatting as a code block. * Tidy up code formats --------- Co-authored-by: Tim <0xtimc@gmail.com>
Motivation:
Documentation isn't formatting correctly, potentially confusing user instructions and examples.
Modifications:
Corrected syntax and adjusted spacing.
Result:
Correct formatting and flow of information.