Skip to content

Commit

Permalink
publish: Add source/images/scipress.svg
Browse files Browse the repository at this point in the history
generated from commit 5b416c12ce605370bb1df76833d19fd0df51f70c
  • Loading branch information
eemeli committed Jun 2, 2024
1 parent d00ffeb commit 2d3c650
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 10 deletions.
14 changes: 9 additions & 5 deletions includes/04_documents
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,15 @@
<span class="c1">// range: [ 145, 180, 180 ] } ],</span>
<span class="c1">// range: [ 102, 180, 180 ] } } ],</span>
<span class="c1">// range: [ 0, 180, 180 ] }</span>
</code></pre></div><h4 id='parsedocument-str-options-document'><code>parseDocument(str, options = {}): Document</code></h4>
</code></pre></div>
<p>These functions should never throw,
provided that <code>str</code> is a string and the <code>options</code> are valid.
Errors and warnings are included in the documents&#39; <code>errors</code> and <code>warnings</code> arrays.
In particular, if <code>errors</code> is not empty
it&#39;s likely that the document&#39;s parsed <code>contents</code> are not entirely correct.</p>

<p>The <code>contents</code> of a parsed document will always consist of <code>Scalar</code>, <code>Map</code>, <code>Seq</code> or <code>null</code> values.</p>
<h4 id='parsedocument-str-options-document'><code>parseDocument(str, options = {}): Document</code></h4>
<p>Parses a single <code>Document</code> from the input <code>str</code>; used internally by <code>parse</code>.
Will include an error if <code>str</code> contains more than one document.
See <a href="#options">Options</a> for more information on the second parameter.</p>
Expand All @@ -45,10 +53,6 @@ See <a href="#options">Options</a> for more information on the second parameter.
See <a href="#options">Options</a> for more information on the second parameter.</p>

<p><br/></p>

<p>These functions should never throw; errors and warnings are included in the documents&#39; <code>errors</code> and <code>warnings</code> arrays. In particular, if <code>errors</code> is not empty it&#39;s likely that the document&#39;s parsed <code>contents</code> are not entirely correct.</p>

<p>The <code>contents</code> of a parsed document will always consist of <code>Scalar</code>, <code>Map</code>, <code>Seq</code> or <code>null</code> values.</p>
<h2 id='creating-documents'>Creating Documents</h2><h4 id='new-document-value-replacer-options'><code>new Document(value, replacer?, options = {})</code></h4>
<p>Creates a new document.
If <code>value</code> is defined, the document <code>contents</code> are initialised with that value, wrapped recursively in appropriate <a href="#content-nodes">content nodes</a>.
Expand Down
14 changes: 9 additions & 5 deletions index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1036,7 +1036,15 @@ <h2 id='parsing-documents'>Parsing Documents</h2><div class="highlight"><pre cla
<span class="c1">// range: [ 145, 180, 180 ] } ],</span>
<span class="c1">// range: [ 102, 180, 180 ] } } ],</span>
<span class="c1">// range: [ 0, 180, 180 ] }</span>
</code></pre></div><h4 id='parsedocument-str-options-document'><code>parseDocument(str, options = {}): Document</code></h4>
</code></pre></div>
<p>These functions should never throw,
provided that <code>str</code> is a string and the <code>options</code> are valid.
Errors and warnings are included in the documents&#39; <code>errors</code> and <code>warnings</code> arrays.
In particular, if <code>errors</code> is not empty
it&#39;s likely that the document&#39;s parsed <code>contents</code> are not entirely correct.</p>

<p>The <code>contents</code> of a parsed document will always consist of <code>Scalar</code>, <code>Map</code>, <code>Seq</code> or <code>null</code> values.</p>
<h4 id='parsedocument-str-options-document'><code>parseDocument(str, options = {}): Document</code></h4>
<p>Parses a single <code>Document</code> from the input <code>str</code>; used internally by <code>parse</code>.
Will include an error if <code>str</code> contains more than one document.
See <a href="#options">Options</a> for more information on the second parameter.</p>
Expand All @@ -1048,10 +1056,6 @@ <h4 id='parsealldocuments-str-options-document'><code>parseAllDocuments(str, opt
See <a href="#options">Options</a> for more information on the second parameter.</p>

<p><br/></p>

<p>These functions should never throw; errors and warnings are included in the documents&#39; <code>errors</code> and <code>warnings</code> arrays. In particular, if <code>errors</code> is not empty it&#39;s likely that the document&#39;s parsed <code>contents</code> are not entirely correct.</p>

<p>The <code>contents</code> of a parsed document will always consist of <code>Scalar</code>, <code>Map</code>, <code>Seq</code> or <code>null</code> values.</p>
<h2 id='creating-documents'>Creating Documents</h2><h4 id='new-document-value-replacer-options'><code>new Document(value, replacer?, options = {})</code></h4>
<p>Creates a new document.
If <code>value</code> is defined, the document <code>contents</code> are initialised with that value, wrapped recursively in appropriate <a href="#content-nodes">content nodes</a>.
Expand Down

0 comments on commit 2d3c650

Please sign in to comment.