From 359d258cae37d7e7e1027e9e8c04f4d33b4e959a Mon Sep 17 00:00:00 2001 From: Cody Boone Ferguson <53008573+xexyl@users.noreply.github.com> Date: Sat, 15 Jun 2024 12:54:53 -0700 Subject: [PATCH] Fix markdown.md no thank you comment format --- markdown.html | 36 ++++++++++++++++++------------------ markdown.md | 36 ++++++++++++++++++------------------ 2 files changed, 36 insertions(+), 36 deletions(-) diff --git a/markdown.html b/markdown.html index 04a2f8bc3..f58b69d8f 100644 --- a/markdown.html +++ b/markdown.html @@ -399,7 +399,7 @@ into the markdown file.

markdown files for the IOCCC:

Please do NOT use the HTML construct:

-
    <a name="string">...</a>                                  <!-- no thank you -->
+
    <a name="string">...</a>                                  <=== no thank you

as those are NOT part of the HTML 5 standard.

Instead use:

    <div id="string">...</div>
@@ -409,7 +409,7 @@ encapsulates the HTML you want to name: i.e., the target of some for the given page URL.

There are certain HTML Elements that cannot have internal <div id="string">...</div>.

For example:

-
    # <div id="string">THIS WILL NOT WORK!</div>              <!-- this will not work -->
+
    # <div id="string">THIS WILL NOT WORK!</div>              <=== this will not work

For things like headings, you have to surround them, as in:

    <div id="string">
     # This will work
@@ -417,18 +417,18 @@ for the given page URL.

 
While some browsers will still recognize the HTML construct <a name="string">...</a>, it is possible they might NOT in the future.

 
Please do NOT use the <strike> or <s> HTML element

 
Please NOT use the obsolete <strike> or <s> (strikeout) HTML elements:

-
    <strike>...</strike>                                      <!-- no thank you -->
-    <s>...</s>                                                <!-- no thank you -->

+
    <strike>...</strike>                                      <=== no thank you
+    <s>...</s>                                                <=== no thank you

 
Use instead:

 
    <del>...</del>

 
Please do NOT use the <u> HTML element

 
Please NOT use the obsolete <u> (underline) HTML element:

-
    <u>...</u>                                                <!-- no thank you -->

+
    <u>...</u>                                                <=== no thank you

 
Use instead:

 
    <ins>...</ins>

 
Please do NOT use the <tt> HTML element

 
Please do NOT use the obsolete <tt> (teletype) HTML element:

-
    <tt>The obsolete tt element is obsolete</tt>              <!-- no thank you -->

+
    <tt>The obsolete tt element is obsolete</tt>              <=== no thank you

 
Instead use either a monospaced span:

 
    <span style="font-family: monospace;">Use of monospaced font is one option</span>

 
Or better and easier still, use an inline markdown code block:

@@ -436,7 +436,7 @@ for the given page URL.

 
Please do NOT use unindented code blocks

 
Please do NOT start code blocks at the left-hand edge.

 
```
-This code block is NOT indented                   <!-- no thank you -->
+This code block is NOT indented                   <=== no thank you
 ```

 
We request that you indent the code block by 4 spaces:

 
```
@@ -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 c4beeac65..0a327d09f 100644
--- a/markdown.md
+++ b/markdown.md
@@ -24,7 +24,7 @@ markdown files for the IOCCC:
 Please do **NOT** use the HTML construct:
 
 ```
-    ...                                  
+    ...                                  <=== no thank you
 ```
 
 as those are **NOT** part of the HTML 5 standard.
@@ -46,7 +46,7 @@ id="string">...`.
 For example:
 
 ```
-    # 
THIS WILL NOT WORK!
              
+    # 
THIS WILL NOT WORK!
              <=== this will not work
 ```
 
 For things like headings, you have to surround them, as in:
@@ -66,8 +66,8 @@ name="string">...`, it is possible they might NOT in the future.
 Please NOT use the obsolete `` or `` (_strikeout_) HTML elements:
 
 ```
-    ...                                      
-    ...                                                
+    ...                                      <=== no thank you
+    ...                                                <=== no thank you
 ```
 
 Use instead:
@@ -82,7 +82,7 @@ Use instead:
 Please NOT use the obsolete `` (_underline_) HTML element:
 
 ```
-    ...                                                
+    ...                                                <=== no thank you
 ```
 
 Use instead:
@@ -97,7 +97,7 @@ Use instead:
 Please do **NOT** use the obsolete `` (_teletype_) HTML element:
 
 ```
-    The obsolete tt element is obsolete              
+    The obsolete tt element is obsolete              <=== no thank you
 ```
 
 Instead use either a monospaced span:
@@ -119,7 +119,7 @@ Please do **NOT** start code blocks at the left-hand edge.
 
 ````
 ```
-This code block is NOT indented                   
+This code block is NOT indented                   <=== no thank you
 ```
 ````
 
@@ -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                                  
+     width=600 height=401 />                                  <=== no thank you
 ```
 
 Instead use just:
@@ -214,7 +214,7 @@ a trailing `
`.
 Instead of:
 
 ```
-    In markdown,\                                             
+    In markdown,\                                             <=== no thank you
     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")                         
+    ![alt text](filename.png "Title")                         <=== no thank you
 ```
 
 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)   
+    ![1984-anonymous-tattoo.jpg](1984-anonymous-tattoo.jpg)   <=== no thank you
 ```
 
 use this HTML:
@@ -318,7 +318,7 @@ to incorrect URLs or file paths.
 Instead of:
 
 ```
-    [some text](https://example.com/foo_(bar))                
+    [some text](https://example.com/foo_(bar))                <=== no thank you
 ```
 
 Use:
@@ -330,7 +330,7 @@ Use:
 Instead of:
 
 ```
-    This thing, ([some text](some/path)), is NOT ideal.       
+    This thing, ([some text](some/path)), is NOT ideal.       <=== no thank you
 ```
 
 Use:
@@ -357,7 +357,7 @@ Instead of:
         return foo;
     }
 ```
-C compilers cannot be given a -Wno-main-arg-errors flag.      
+C compilers cannot be given a -Wno-main-arg-errors flag.      <=== no thank you
 ````
 
 Use:
@@ -384,7 +384,7 @@ Please do **NOT** use parenthesis inside the markdown link titles.
 Instead of:
 
 ```
-    [some (text)](https://example.com/cyrds)                  
+    [some (text)](https://example.com/cyrds)                  <=== no thank you
 ```
 
 Use:
@@ -396,7 +396,7 @@ Use:
 Instead of:
 
 ```
-    [ls(1)](https://example.com/ls-man-page.1)                
+    [ls(1)](https://example.com/ls-man-page.1)                <=== no thank you
 ```
 
 Use: