mirror/ioccc
1
0 Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Important typo fixes in FAQ

Browse Source 
There were some cases where the wrong JSON member was referenced when
explaining a different JSON member (in author details).

Also to help clarify the part about if the value is unknown, I have
changed it to be 'it should be ...' rather than 'they should use' since
obviously the author themselves ought to know their email, URL, alt URL
etc. :-)
This commit is contained in:
Cody Boone Ferguson committed 2024-05-31 09:23:10 -07:00
1 parent f7e0f30365
commit 8af06bbb30
2 files changed
+30 -30
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

faq.html
+15 -15
View File
@@ -2520,7 +2520,7 @@ a country, such as “Antarctica” or a User-assigned code.</p>
<p>There <strong>MUST</strong> be one and only one <code>email</code> <em>JSON member</em> and the <em>JSON value</em> <strong>MUST</strong>
be a <em>JSON string</em> or it <strong>MUST</strong> be a <em>JSON null</em>.</p>
<p>If the author wishes to not specify an email address, or if the email address is
unknown, they should use the <em>JSON null</em> as the <em>JSON value</em> of this <em>JSON member</em>.
unknown, it should be the <em>JSON null</em> as the <em>JSON value</em> of this <em>JSON member</em>.
For example:</p>
<pre><code> &quot;email&quot; : null,</code></pre>
<p>NOTE: The <em>JSON null</em> is <strong>NOT</strong> enclosed in quotes!</p>
@@ -2529,24 +2529,24 @@ For example:</p>
<p>This <em>JSON member</em> holds the URL of the author’s home page.</p>
<p>There <strong>MUST</strong> be one and only one <code>url</code> <em>JSON member</em> and the <em>JSON value</em> <strong>MUST</strong>
be a <em>JSON string</em> or it <strong>MUST</strong> be a <em>JSON null</em>.</p>
<p>If the author wishes to not specify an email address, or if the URL is
unknown, they should use the <em>JSON null</em> as the <em>JSON value</em> of this <em>JSON member</em>.
For example:</p>
<p>If the author wishes to not specify a URL or if the URL is
unknown, it should be the <em>JSON null</em> as the <em>JSON value</em> of this <em>JSON
member</em>. For example:</p>
<pre><code> &quot;url&quot; : null,</code></pre>
<p>NOTE: The <em>JSON null</em> is <strong>NOT</strong> enclosed in quotes!</p>
<h5 id="alt_url">alt_url</h5>
<pre><code> &quot;alt_url&quot; : null,</code></pre>
<p>This <em>JSON member</em> holds an alternate or 2nd URL a home page for the author.</p>
<p>There <strong>MUST</strong> be one and only one <code>url</code> <em>JSON member</em> and the <em>JSON value</em> <strong>MUST</strong>
<p>There <strong>MUST</strong> be one and only one <code>alt_url</code> <em>JSON member</em> and the <em>JSON value</em> <strong>MUST</strong>
be a <em>JSON string</em> or it <strong>MUST</strong> be a <em>JSON null</em>.</p>
<p>In some cases the author may wish to record a special URL for their IOCCC entry,
or a 2nd URL such as a work or school or personal home page. For example,
Cody as of <em>Thu Nov 30 23:51:12 UTC 2023</em> used:</p>
<pre><code> &quot;alt_url&quot; : &quot;https://ioccc.xexyl.net&quot;,</code></pre>
<p>If the author wishes to not specify an email address, or if the alternate URL is
unknown, they should use the <em>JSON null</em> as the <em>JSON value</em> of this <em>JSON member</em>.
For example:</p>
<pre><code> &quot;url&quot; : null,</code></pre>
<p>If the author wishes to not specify an alternate URL, or if the alternate URL is
unknown, it should be the <em>JSON null</em> as the <em>JSON value</em> of this <em>JSON
member</em>. For example:</p>
<pre><code> &quot;alt_url&quot; : null,</code></pre>
<p>NOTE: The <em>JSON null</em> is <strong>NOT</strong> enclosed in quotes!</p>
<h5 id="deprecated_twitter_handle">deprecated_twitter_handle</h5>
<p>This <em>JSON member</em> used to hold the twitter handle of the author.</p>
@@ -2557,8 +2557,8 @@ and so the <code>deprecated_twitter_handle</code> is <strong>no longer used</str
not a <em>JSON null</em> is kept for only historic reasons. For example, Anthony C. Howe
once used:</p>
<pre><code> &quot;deprecated_twitter_handle&quot; : &quot;@SirWumpus&quot;,</code></pre>
<p>If the author wishes to not specify an twitter handle, or if the twitter handle is
unknown, they should use the <em>JSON null</em> as the <em>JSON value</em> of this <em>JSON member</em>.
<p>If the author wishes to not specify a twitter handle, or if the twitter handle is
unknown, it should be the <em>JSON null</em> as the <em>JSON value</em> of this <em>JSON member</em>.
For example:</p>
<pre><code> &quot;deprecated_twitter_handle&quot; : null,</code></pre>
<p>NOTE: The <em>JSON null</em> is <strong>NOT</strong> enclosed in quotes!</p>
@@ -2581,7 +2581,7 @@ as the opening and closing of a new IOCCC, changes to the IOCCC web
site, updates during the judging process, and when new IOCCC entries
are selected. We recommend you follow us on Mastodon.</p>
<p>If the author wishes to not specify an Mastodon handle, or if the Mastodon handle is
unknown, they should use the <em>JSON null</em> as the <em>JSON value</em> of this <em>JSON member</em>.
unknown, it should be the <em>JSON null</em> as the <em>JSON value</em> of this <em>JSON member</em>.
For example:</p>
<pre><code> &quot;mastodon&quot; : null,</code></pre>
<p>NOTE: The <em>JSON null</em> is <strong>NOT</strong> enclosed in quotes!</p>
@@ -2598,7 +2598,7 @@ For example, if the Mastodon handle is:</p>
<p>Then the <code>mastodon_url</code> would be:</p>
<pre><code> https://server.domain/@user</code></pre>
<p>If the author wishes to not specify an Mastodon URL, or if the Mastodon URL is
unknown, they should use the <em>JSON null</em> as the <em>JSON value</em> of this <em>JSON member</em>.
unknown, it should be the <em>JSON null</em> as the <em>JSON value</em> of this <em>JSON member</em>.
For example:</p>
<pre><code> &quot;mastodon_url&quot; : null,</code></pre>
<p>NOTE: The <em>JSON null</em> is <strong>NOT</strong> enclosed in quotes!</p>
@@ -2615,7 +2615,7 @@ and hosts <a href="https://www.ioccc.org">official IOCCC web site</a> on GitHub
<p>The IOCCC GitHub handle is:</p>
<pre><code> @ioccc-src</code></pre>
<p>If the author wishes to not specify an GitHub handle, or if the GitHub handle is
unknown, they should use the <em>JSON null</em> as the <em>JSON value</em> of this <em>JSON member</em>.
unknown, it should be the <em>JSON null</em> as the <em>JSON value</em> of this <em>JSON member</em>.
For example:</p>
<pre><code> &quot;github&quot; : null,</code></pre>
<p>NOTE: The <em>JSON null</em> is <strong>NOT</strong> enclosed in quotes!</p>
@@ -2629,7 +2629,7 @@ It is recommended that the affiliation <em>JSON string</em> be the formal affili
For example, the affiliation for the IOCCC would be:</p>
<pre><code> The International Obfuscared C Code Contest</code></pre>
<p>If the author wishes to not specify an affiliation, or if the affiliation is
unknown, they should use the <em>JSON null</em> as the <em>JSON value</em> of this <em>JSON member</em>.
unknown, it should be the <em>JSON null</em> as the <em>JSON value</em> of this <em>JSON member</em>.
For example:</p>
<pre><code> &quot;affiliation&quot; : null,</code></pre>
<p>NOTE: The <em>JSON null</em> is <strong>NOT</strong> enclosed in quotes!</p>
faq.md
+15 -15
View File
@@ -3140,7 +3140,7 @@ There **MUST** be one and only one `email` _JSON member_ and the _JSON value_ **
be a _JSON string_ or it **MUST** be a _JSON null_.
If the author wishes to not specify an email address, or if the email address is
unknown, they should use the _JSON null_ as the _JSON value_ of this _JSON member_.
unknown, it should be the _JSON null_ as the _JSON value_ of this _JSON member_.
For example:
``` <!---json-->
@@ -3161,9 +3161,9 @@ This _JSON member_ holds the URL of the author's home page.
There **MUST** be one and only one `url` _JSON member_ and the _JSON value_ **MUST**
be a _JSON string_ or it **MUST** be a _JSON null_.
If the author wishes to not specify an email address, or if the URL is
unknown, they should use the _JSON null_ as the _JSON value_ of this _JSON member_.
For example:
If the author wishes to not specify a URL or if the URL is
unknown, it should be the _JSON null_ as the _JSON value_ of this _JSON
member_. For example:
``` <!---json-->
"url" : null,
@@ -3180,7 +3180,7 @@ NOTE: The _JSON null_ is **NOT** enclosed in quotes!
This _JSON member_ holds an alternate or 2nd URL a home page for the author.
There **MUST** be one and only one `url` _JSON member_ and the _JSON value_ **MUST**
There **MUST** be one and only one `alt_url` _JSON member_ and the _JSON value_ **MUST**
be a _JSON string_ or it **MUST** be a _JSON null_.
In some cases the author may wish to record a special URL for their IOCCC entry,
@@ -3191,12 +3191,12 @@ Cody as of _Thu Nov 30 23:51:12 UTC 2023_ used:
"alt_url" : "https://ioccc.xexyl.net",
```
If the author wishes to not specify an email address, or if the alternate URL is
unknown, they should use the _JSON null_ as the _JSON value_ of this _JSON member_.
For example:
If the author wishes to not specify an alternate URL, or if the alternate URL is
unknown, it should be the _JSON null_ as the _JSON value_ of this _JSON
member_. For example:
``` <!---json-->
"url" : null,
"alt_url" : null,
```
NOTE: The _JSON null_ is **NOT** enclosed in quotes!
@@ -3218,8 +3218,8 @@ once used:
"deprecated_twitter_handle" : "@SirWumpus",
```
If the author wishes to not specify an twitter handle, or if the twitter handle is
unknown, they should use the _JSON null_ as the _JSON value_ of this _JSON member_.
If the author wishes to not specify a twitter handle, or if the twitter handle is
unknown, it should be the _JSON null_ as the _JSON value_ of this _JSON member_.
For example:
``` <!---json-->
@@ -3260,7 +3260,7 @@ site, updates during the judging process, and when new IOCCC entries
are selected. We recommend you follow us on Mastodon.
If the author wishes to not specify an Mastodon handle, or if the Mastodon handle is
unknown, they should use the _JSON null_ as the _JSON value_ of this _JSON member_.
unknown, it should be the _JSON null_ as the _JSON value_ of this _JSON member_.
For example:
``` <!---json-->
@@ -3297,7 +3297,7 @@ Then the `mastodon_url` would be:
```
If the author wishes to not specify an Mastodon URL, or if the Mastodon URL is
unknown, they should use the _JSON null_ as the _JSON value_ of this _JSON member_.
unknown, it should be the _JSON null_ as the _JSON value_ of this _JSON member_.
For example:
``` <!---json-->
@@ -3332,7 +3332,7 @@ The IOCCC GitHub handle is:
```
If the author wishes to not specify an GitHub handle, or if the GitHub handle is
unknown, they should use the _JSON null_ as the _JSON value_ of this _JSON member_.
unknown, it should be the _JSON null_ as the _JSON value_ of this _JSON member_.
For example:
``` <!---json-->
@@ -3362,7 +3362,7 @@ For example, the affiliation for the IOCCC would be:
```
If the author wishes to not specify an affiliation, or if the affiliation is
unknown, they should use the _JSON null_ as the _JSON value_ of this _JSON member_.
unknown, it should be the _JSON null_ as the _JSON value_ of this _JSON member_.
For example:
``` <!---json-->