From fb59e1203fbd98066672b16453301a9bfa6237c3 Mon Sep 17 00:00:00 2001 From: Cody Boone Ferguson <53008573+xexyl@users.noreply.github.com> Date: Sat, 15 Jun 2024 11:33:12 -0700 Subject: [PATCH] Fix links/formatting in markdown.md Something that was not noted in the other commit that touched this file is that because this is markdown which renders to html I changed the comments in the form of: <=== no thank you to This was not strictly necessary but and for non html it might not even make sense except that it is still rendered to html and in most cases (if not all) it is html. This was done for the rest of the file now too. --- markdown.html | 22 +++++++++++----------- markdown.md | 22 +++++++++++----------- 2 files changed, 22 insertions(+), 22 deletions(-) diff --git a/markdown.html b/markdown.html index 7dd0730fb..3833124f8 100644 --- a/markdown.html +++ b/markdown.html @@ -462,17 +462,17 @@ tags.

The trailing slash on void HTML elements has no effect and interacts badly with unquoted attribute values.

For example, please do NOT use:

-
    <br/>                                                     <=== no thank you
+
    <br/>                                                     <!-- no thank you -->

Instead use just:

    <br>

And for example, please do NOT use:

-
    <hr/>                                                     <=== no thank you
+
    <hr/>                                                     <!-- no thank you -->

Instead use just:

    <hr>

And for example, please do NOT use:

    <img src="1984-anonymous-tattoo.jpg"
      alt="image of a tattoo of the 1984 anonymous C code"
-     width=600 height=401 />                                  <=== no thank you
+ width=600 height=401 /> <!-- no thank you -->

Instead use just:

    <img src="1984-anonymous-tattoo.jpg"
      alt="image of a tattoo of the 1984 anonymous C code"
@@ -483,7 +483,7 @@ unquoted attribute values.

 end a markdown line with a trailing backslash (\). Instead use
 a trailing <br>.

 
Instead of:

-
    In markdown,\                                             <=== no thank you
+
    In markdown,\                                             <!-- no thank you -->
     do NOT use trailing\
     backslashes outside of\
     a code block

@@ -504,14 +504,14 @@ a trailing <br>.

 
Please do NOT use markdown style images

 
Please do NOT use the markdown embedded image element.

 
Instead of using this markdown element to embed an image:

-
    ![alt text](filename.png "Title")                         <=== no thank you

+
    ![alt text](filename.png "Title")                         <!-- no thank you -->

 
Use an <img ..> HTML element with alt=, width= and length=
 attributes:

 
    <img src="filename.png"
      alt="describe the filename.png image for someone who cannot view it"
      width=PIXEL_WIDTH height=PIXEL_HEIGHT>

 
For example, instead of:

-
    ![1984-anonymous-tattoo.jpg](1984-anonymous-tattoo.jpg)   <=== no thank you

+
    ![1984-anonymous-tattoo.jpg](1984-anonymous-tattoo.jpg)   <!-- no thank you -->

 
use this HTML:

 
    <img src="1984-anonymous-tattoo.jpg"
      alt="image of a tattoo of the 1984 anonymous C code"
@@ -537,11 +537,11 @@ standard HTML 5 and interacts badly with unquoted attribute values.

 
Markdown links that end in “))” complicate parsing and sometimes lead
 to incorrect URLs or file paths.

 
Instead of:

-
    [some text](https://example.com/foo_(bar))                <=== no thank you

+
    [some text](https://example.com/foo_(bar))                <!-- no thank you -->

 
Use:

 
    [some text](https://example.com/foo_&#x28;bar&#x29;)

 
Instead of:

-
    This thing, ([some text](some/path)), is NOT ideal.       <=== no thank you

+
    This thing, ([some text](some/path)), is NOT ideal.       <!-- no thank you -->

 
Use:

 
    This thing, [some text](some/path), is better.

 
Please do NOT place text on the next line after a markdown code block

@@ -557,7 +557,7 @@ NOT properly indented.

         return foo;
     }
 ```
-C compilers cannot be given a -Wno-main-arg-errors flag.      <=== no thank you

+C compilers cannot be given a -Wno-main-arg-errors flag.      <!-- no thank you -->

 
Use:

 
```
     int
@@ -572,11 +572,11 @@ C compilers cannot be given a -Wno-main-arg-errors flag.

 
 
Please do NOT use parenthesis inside the markdown link titles.

 
Instead of:

-
    [some (text)](https://example.com/cyrds)                  <=== no thank you

+
    [some (text)](https://example.com/cyrds)                  <!-- no thank you -->

 
Use:

 
    [some &#x28;text&#x29;](https://example.com/cyrds)

 
Instead of:

-
    [ls(1)](https://example.com/ls-man-page.1)                <=== no thank you

+
    [ls(1)](https://example.com/ls-man-page.1)                <-- no thank you -->

 
Use:

 
    [ls&#x28;1&#x29;](https://example.com/ls-man-page.1)

 
diff --git a/markdown.md b/markdown.md
index 9f91caeb2..bca4166dd 100644
--- a/markdown.md
+++ b/markdown.md
@@ -165,7 +165,7 @@ unquoted attribute values.
 For example, please do NOT use:
 
 ```
-    
                                                     <=== no thank you
+    
                                                     
 ```
 
 Instead use just:
@@ -177,7 +177,7 @@ Instead use just:
 And for example, please do NOT use:
 
 ```
-    
                                                     <=== no thank you
+    
                                                     
 ```
 
 Instead use just:
@@ -191,7 +191,7 @@ And for example, please do NOT use:
 ```
     image of a tattoo of the 1984 anonymous C code                                  <=== no thank you
+     width=600 height=401 />                                  
 ```
 
 Instead use just:
@@ -214,7 +214,7 @@ a trailing `
`.
 Instead of:
 
 ```
-    In markdown,\                                             <=== no thank you
+    In markdown,\                                             
     do NOT use trailing\
     backslashes outside of\
     a code block
@@ -251,7 +251,7 @@ Please do **NOT** use the markdown embedded image element.
 Instead of using this markdown element to embed an image:
 
 ```
-    ![alt text](filename.png "Title")                         <=== no thank you
+    ![alt text](filename.png "Title")                         
 ```
 
 Use an `` HTML element with `alt=`, `width=` and `length=`
@@ -266,7 +266,7 @@ attributes:
 For example, instead of:
 
 ```
-    ![1984-anonymous-tattoo.jpg](1984-anonymous-tattoo.jpg)   <=== no thank you
+    ![1984-anonymous-tattoo.jpg](1984-anonymous-tattoo.jpg)   
 ```
 
 use this HTML:
@@ -318,7 +318,7 @@ to incorrect URLs or file paths.
 Instead of:
 
 ```
-    [some text](https://example.com/foo_(bar))                <=== no thank you
+    [some text](https://example.com/foo_(bar))                
 ```
 
 Use:
@@ -330,7 +330,7 @@ Use:
 Instead of:
 
 ```
-    This thing, ([some text](some/path)), is NOT ideal.       <=== no thank you
+    This thing, ([some text](some/path)), is NOT ideal.       
 ```
 
 Use:
@@ -357,7 +357,7 @@ Instead of:
         return foo;
     }
 ```
-C compilers cannot be given a -Wno-main-arg-errors flag.      <=== no thank you
+C compilers cannot be given a -Wno-main-arg-errors flag.      
 ````
 
 Use:
@@ -384,7 +384,7 @@ Please do **NOT** use parenthesis inside the markdown link titles.
 Instead of:
 
 ```
-    [some (text)](https://example.com/cyrds)                  <=== no thank you
+    [some (text)](https://example.com/cyrds)                  
 ```
 
 Use:
@@ -396,7 +396,7 @@ Use:
 Instead of:
 
 ```
-    [ls(1)](https://example.com/ls-man-page.1)                <=== no thank you
+    [ls(1)](https://example.com/ls-man-page.1)                <-- no thank you -->
 ```
 
 Use: