build based on 57f663f

dev/advising/index.html

@@ -28,7 +28,7 @@
             result
         end
         (post ∘ writecommit, writefn, (output, info))
-    end)</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/tecosaur/DataToolkitBase.jl/blob/ede2593178514fac893a847dfbd184986c742a63/src/model/types.jl#LL151-L236">source</a></section></article><h2 id="Advisement-points"><a class="docs-heading-anchor" href="#Advisement-points">Advisement points</a><a id="Advisement-points-1"></a><a class="docs-heading-anchor-permalink" href="#Advisement-points" title="Permalink"></a></h2><h3 id="Parsing-and-serialisation-of-data-sets-and-collections"><a class="docs-heading-anchor" href="#Parsing-and-serialisation-of-data-sets-and-collections">Parsing and serialisation of data sets and collections</a><a id="Parsing-and-serialisation-of-data-sets-and-collections-1"></a><a class="docs-heading-anchor-permalink" href="#Parsing-and-serialisation-of-data-sets-and-collections" title="Permalink"></a></h3><p><code>DataCollection</code>​s, <code>DataSet</code>​s, and <code>AbstractDataTransformer</code>​s are advised at two stages during parsing:</p><ol><li>When calling <code>fromspec</code> on the <code>Dict</code> representation, at the start of</li></ol><p>parsing</p><ol><li>At the end of the <code>fromspec</code> function, calling <code>identity</code> on the object</li></ol><p>Serialisation is performed through the <code>tospec</code> call, which is also advised.</p><p>The signatures of the advised function calls are as follows:</p><pre><code class="language-julia hljs">fromspec(DataCollection, spec::Dict{String, Any}; path::Union{String, Nothing})::DataCollection
+    end)</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/tecosaur/DataToolkitBase.jl/blob/57f663f65dac46090f173a1a3f84870ff8d22e27/src/model/types.jl#LL151-L236">source</a></section></article><h2 id="Advisement-points"><a class="docs-heading-anchor" href="#Advisement-points">Advisement points</a><a id="Advisement-points-1"></a><a class="docs-heading-anchor-permalink" href="#Advisement-points" title="Permalink"></a></h2><h3 id="Parsing-and-serialisation-of-data-sets-and-collections"><a class="docs-heading-anchor" href="#Parsing-and-serialisation-of-data-sets-and-collections">Parsing and serialisation of data sets and collections</a><a id="Parsing-and-serialisation-of-data-sets-and-collections-1"></a><a class="docs-heading-anchor-permalink" href="#Parsing-and-serialisation-of-data-sets-and-collections" title="Permalink"></a></h3><p><code>DataCollection</code>​s, <code>DataSet</code>​s, and <code>AbstractDataTransformer</code>​s are advised at two stages during parsing:</p><ol><li>When calling <code>fromspec</code> on the <code>Dict</code> representation, at the start of</li></ol><p>parsing</p><ol><li>At the end of the <code>fromspec</code> function, calling <code>identity</code> on the object</li></ol><p>Serialisation is performed through the <code>tospec</code> call, which is also advised.</p><p>The signatures of the advised function calls are as follows:</p><pre><code class="language-julia hljs">fromspec(DataCollection, spec::Dict{String, Any}; path::Union{String, Nothing})::DataCollection
 identity(collection::DataCollection)::DataCollection
 tospec(collection::DataCollection)::Dict</code></pre><pre><code class="language-julia hljs">fromspec(DataSet, collection::DataCollection, name::String, spec::Dict{String, Any})::DataSet
 identity(dataset::DataSet)::DataSet
@@ -37,4 +37,4 @@
 tospec(adt::AbstractDataTransformer)::Dict</code></pre><h3 id="Processing-identifiers"><a class="docs-heading-anchor" href="#Processing-identifiers">Processing identifiers</a><a id="Processing-identifiers-1"></a><a class="docs-heading-anchor-permalink" href="#Processing-identifiers" title="Permalink"></a></h3><p>Both the parsing of an <code>Identifier</code> from a string, and the serialisation of an <code>Identifier</code> to a string are advised. Specifically, the following function calls:</p><pre><code class="language-julia hljs">parse(Identifier, spec::AbstractString, advised=true)
 string(ident::Identifier)</code></pre><h3 id="The-data-flow-arrows"><a class="docs-heading-anchor" href="#The-data-flow-arrows">The data flow arrows</a><a id="The-data-flow-arrows-1"></a><a class="docs-heading-anchor-permalink" href="#The-data-flow-arrows" title="Permalink"></a></h3><p>The reading, writing, and storage of data may all be advised. Specifically, the following function calls:</p><pre><code class="language-julia hljs">load(loader::DataLoader, datahandle, as::Type)
 storage(provider::DataStorage, as::Type; write::Bool)
-save(writer::DataWriter, datahandle, info)</code></pre><h2 id="Index-of-advised-calls"><a class="docs-heading-anchor" href="#Index-of-advised-calls">Index of advised calls</a><a id="Index-of-advised-calls-1"></a><a class="docs-heading-anchor-permalink" href="#Index-of-advised-calls" title="Permalink"></a></h2><p>There are <strong>0</strong> advised function calls, across <strong>0</strong> files, covering <strong>0</strong> functions (automatically detected).</p><h3>Arranged by function</h3><h3>Arranged by file</h3></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../packages/">« Packages</a><a class="docs-footer-nextpage" href="../libinternal/">Internals »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 0.27.25 on <span class="colophon-date" title="Sunday 16 July 2023 11:39">Sunday 16 July 2023</span>. Using Julia version 1.9.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+save(writer::DataWriter, datahandle, info)</code></pre><h2 id="Index-of-advised-calls"><a class="docs-heading-anchor" href="#Index-of-advised-calls">Index of advised calls</a><a id="Index-of-advised-calls-1"></a><a class="docs-heading-anchor-permalink" href="#Index-of-advised-calls" title="Permalink"></a></h2><p>There are <strong>0</strong> advised function calls, across <strong>0</strong> files, covering <strong>0</strong> functions (automatically detected).</p><h3>Arranged by function</h3><h3>Arranged by file</h3></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../packages/">« Packages</a><a class="docs-footer-nextpage" href="../libinternal/">Internals »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 0.27.25 on <span class="colophon-date" title="Sunday 16 July 2023 15:44">Sunday 16 July 2023</span>. Using Julia version 1.9.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

dev/datatoml/index.html

@@ -39,4 +39,4 @@
 type=["a QualifiedType", ...] # probably optional
 type="a QualifiedType" # single-value alternative form
 priority=1 # (optional)
-# other properties...</code></pre><p>A data set is a top-level instance of an <a href="https://toml.io/en/v1.0.0#array-of-tables">array of tables</a>, with any name other than <code>data</code>. Data set names need not be unique, but should be able to be uniquely identified by the combination of their name and parameters.</p><p>Apart from data transformers, there is one recognised data property: <code>uuid</code>, a UUIDv4 string. Any number of additional properties may be given (so long as they do not conflict with the transformer names), they may have special behaviour based on plugins or extensions loaded, but will not be treated specially by DataToolkitBase.</p><p>A data set can have any number of data transformers, but at least two are needed for a functional data set. Data transformers are instances of an array of tables (like data sets), but directly under the data set table.</p><h2 id="Structure-of-a-data-transformer"><a class="docs-heading-anchor" href="#Structure-of-a-data-transformer">Structure of a data transformer</a><a id="Structure-of-a-data-transformer-1"></a><a class="docs-heading-anchor-permalink" href="#Structure-of-a-data-transformer" title="Permalink"></a></h2><p>There are three data transformers types, with the following names:</p><ul><li><code>storage</code></li><li><code>loader</code></li><li><code>writer</code></li></ul><p>All transformers recognise three properties:</p><ul><li><code>driver</code>, the transformer driver name, as a string</li><li><code>type</code>, a single <code>QualifiedType</code> string, or an array of them</li><li><code>priority</code>, an integer which sets the order in which multiple transformers should be considered</li></ul><p>The <code>driver</code> property is mandatory. <code>type</code> and <code>priority</code> can be omitted, in which case they will adopt the default values. The default <code>type</code> value is either determined dynamically from the available methods, or set for that particular transformer.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../usage/">« Usage</a><a class="docs-footer-nextpage" href="../repl/">REPL »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 0.27.25 on <span class="colophon-date" title="Sunday 16 July 2023 11:39">Sunday 16 July 2023</span>. Using Julia version 1.9.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+# other properties...</code></pre><p>A data set is a top-level instance of an <a href="https://toml.io/en/v1.0.0#array-of-tables">array of tables</a>, with any name other than <code>data</code>. Data set names need not be unique, but should be able to be uniquely identified by the combination of their name and parameters.</p><p>Apart from data transformers, there is one recognised data property: <code>uuid</code>, a UUIDv4 string. Any number of additional properties may be given (so long as they do not conflict with the transformer names), they may have special behaviour based on plugins or extensions loaded, but will not be treated specially by DataToolkitBase.</p><p>A data set can have any number of data transformers, but at least two are needed for a functional data set. Data transformers are instances of an array of tables (like data sets), but directly under the data set table.</p><h2 id="Structure-of-a-data-transformer"><a class="docs-heading-anchor" href="#Structure-of-a-data-transformer">Structure of a data transformer</a><a id="Structure-of-a-data-transformer-1"></a><a class="docs-heading-anchor-permalink" href="#Structure-of-a-data-transformer" title="Permalink"></a></h2><p>There are three data transformers types, with the following names:</p><ul><li><code>storage</code></li><li><code>loader</code></li><li><code>writer</code></li></ul><p>All transformers recognise three properties:</p><ul><li><code>driver</code>, the transformer driver name, as a string</li><li><code>type</code>, a single <code>QualifiedType</code> string, or an array of them</li><li><code>priority</code>, an integer which sets the order in which multiple transformers should be considered</li></ul><p>The <code>driver</code> property is mandatory. <code>type</code> and <code>priority</code> can be omitted, in which case they will adopt the default values. The default <code>type</code> value is either determined dynamically from the available methods, or set for that particular transformer.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../usage/">« Usage</a><a class="docs-footer-nextpage" href="../repl/">REPL »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 0.27.25 on <span class="colophon-date" title="Sunday 16 July 2023 15:44">Sunday 16 July 2023</span>. Using Julia version 1.9.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>