Skip to content

Commit

Permalink
docs update
Browse files Browse the repository at this point in the history
  • Loading branch information
dirkroorda committed May 13, 2024
1 parent 863f3e3 commit c48cd47
Show file tree
Hide file tree
Showing 150 changed files with 1,083 additions and 980 deletions.
8 changes: 7 additions & 1 deletion index.js

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion tf/about/annotate.html
Original file line number Diff line number Diff line change
Expand Up @@ -298,7 +298,7 @@ <h3 id="recommended-practice">Recommended practice</h3>
<details class="source">
<summary>
<span>Expand source code</span>
<a href="https://github.com/annotation/text-fabric/blob/81c7208eecee1adac51470e747edd3781135e950/tf/about/annotate.py#L1-L3" class="git-link">Browse git</a>
<a href="https://github.com/annotation/text-fabric/blob/703d3977ff845baafe67bbbaa3a678e8deb2b911/tf/about/annotate.py#L1-L3" class="git-link">Browse git</a>
</summary>
<pre><code class="python">&#34;&#34;&#34;
.. include:: ../docs/about/annotate.md
Expand Down
2 changes: 1 addition & 1 deletion tf/about/annotateBrowser.html
Original file line number Diff line number Diff line change
Expand Up @@ -267,7 +267,7 @@ <h1 id="programming">Programming</h1>
<details class="source">
<summary>
<span>Expand source code</span>
<a href="https://github.com/annotation/text-fabric/blob/81c7208eecee1adac51470e747edd3781135e950/tf/about/annotateBrowser.py#L1-L3" class="git-link">Browse git</a>
<a href="https://github.com/annotation/text-fabric/blob/703d3977ff845baafe67bbbaa3a678e8deb2b911/tf/about/annotateBrowser.py#L1-L3" class="git-link">Browse git</a>
</summary>
<pre><code class="python">&#34;&#34;&#34;
.. include:: ../docs/about/annotateBrowser.md
Expand Down
2 changes: 1 addition & 1 deletion tf/about/apps.html
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@ <h3 id="two-contexts">Two contexts</h3>
<details class="source">
<summary>
<span>Expand source code</span>
<a href="https://github.com/annotation/text-fabric/blob/81c7208eecee1adac51470e747edd3781135e950/tf/about/apps.py#L1-L3" class="git-link">Browse git</a>
<a href="https://github.com/annotation/text-fabric/blob/703d3977ff845baafe67bbbaa3a678e8deb2b911/tf/about/apps.py#L1-L3" class="git-link">Browse git</a>
</summary>
<pre><code class="python">&#34;&#34;&#34;
.. include:: ../docs/about/apps.md
Expand Down
2 changes: 1 addition & 1 deletion tf/about/background.html
Original file line number Diff line number Diff line change
Expand Up @@ -155,7 +155,7 @@ <h2 id="history">History</h2>
<details class="source">
<summary>
<span>Expand source code</span>
<a href="https://github.com/annotation/text-fabric/blob/81c7208eecee1adac51470e747edd3781135e950/tf/about/background.py#L1-L3" class="git-link">Browse git</a>
<a href="https://github.com/annotation/text-fabric/blob/703d3977ff845baafe67bbbaa3a678e8deb2b911/tf/about/background.py#L1-L3" class="git-link">Browse git</a>
</summary>
<pre><code class="python">&#34;&#34;&#34;
.. include:: ../docs/about/background.md
Expand Down
2 changes: 1 addition & 1 deletion tf/about/browser.html
Original file line number Diff line number Diff line change
Expand Up @@ -174,7 +174,7 @@ <h3 id="unicode-in-excel-csvs">UNICODE in Excel CSVs</h3>
<details class="source">
<summary>
<span>Expand source code</span>
<a href="https://github.com/annotation/text-fabric/blob/81c7208eecee1adac51470e747edd3781135e950/tf/about/browser.py#L1-L3" class="git-link">Browse git</a>
<a href="https://github.com/annotation/text-fabric/blob/703d3977ff845baafe67bbbaa3a678e8deb2b911/tf/about/browser.py#L1-L3" class="git-link">Browse git</a>
</summary>
<pre><code class="python">&#34;&#34;&#34;
.. include:: ../docs/about/browser.md
Expand Down
2 changes: 1 addition & 1 deletion tf/about/clientmanual.html
Original file line number Diff line number Diff line change
Expand Up @@ -565,7 +565,7 @@ <h1 id="credits">Credits</h1>
<details class="source">
<summary>
<span>Expand source code</span>
<a href="https://github.com/annotation/text-fabric/blob/81c7208eecee1adac51470e747edd3781135e950/tf/about/clientmanual.py#L1-L3" class="git-link">Browse git</a>
<a href="https://github.com/annotation/text-fabric/blob/703d3977ff845baafe67bbbaa3a678e8deb2b911/tf/about/clientmanual.py#L1-L3" class="git-link">Browse git</a>
</summary>
<pre><code class="python">&#34;&#34;&#34;
.. include:: ../docs/about/clientmanual.md
Expand Down
2 changes: 1 addition & 1 deletion tf/about/code.html
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ <h2 id="writing">Writing</h2>
<details class="source">
<summary>
<span>Expand source code</span>
<a href="https://github.com/annotation/text-fabric/blob/81c7208eecee1adac51470e747edd3781135e950/tf/about/code.py#L1-L3" class="git-link">Browse git</a>
<a href="https://github.com/annotation/text-fabric/blob/703d3977ff845baafe67bbbaa3a678e8deb2b911/tf/about/code.py#L1-L3" class="git-link">Browse git</a>
</summary>
<pre><code class="python">&#34;&#34;&#34;
.. include:: ../docs/about/code.md
Expand Down
2 changes: 1 addition & 1 deletion tf/about/corpora.html
Original file line number Diff line number Diff line change
Expand Up @@ -351,7 +351,7 @@ <h3 id="extra-data">Extra data</h3>
<details class="source">
<summary>
<span>Expand source code</span>
<a href="https://github.com/annotation/text-fabric/blob/81c7208eecee1adac51470e747edd3781135e950/tf/about/corpora.py#L1-L3" class="git-link">Browse git</a>
<a href="https://github.com/annotation/text-fabric/blob/703d3977ff845baafe67bbbaa3a678e8deb2b911/tf/about/corpora.py#L1-L3" class="git-link">Browse git</a>
</summary>
<pre><code class="python">&#34;&#34;&#34;
.. include:: ../docs/about/corpora.md
Expand Down
2 changes: 1 addition & 1 deletion tf/about/datamodel.html
Original file line number Diff line number Diff line change
Expand Up @@ -265,7 +265,7 @@ <h2 id="serializing-and-pre-computing">Serializing and pre-computing</h2>
<details class="source">
<summary>
<span>Expand source code</span>
<a href="https://github.com/annotation/text-fabric/blob/81c7208eecee1adac51470e747edd3781135e950/tf/about/datamodel.py#L1-L3" class="git-link">Browse git</a>
<a href="https://github.com/annotation/text-fabric/blob/703d3977ff845baafe67bbbaa3a678e8deb2b911/tf/about/datamodel.py#L1-L3" class="git-link">Browse git</a>
</summary>
<pre><code class="python">&#34;&#34;&#34;
.. include:: ../docs/about/datamodel.md
Expand Down
2 changes: 1 addition & 1 deletion tf/about/datasharing.html
Original file line number Diff line number Diff line change
Expand Up @@ -362,7 +362,7 @@ <h3 id="more-modules-at-the-same-time">More modules at the same time</h3>
<details class="source">
<summary>
<span>Expand source code</span>
<a href="https://github.com/annotation/text-fabric/blob/81c7208eecee1adac51470e747edd3781135e950/tf/about/datasharing.py#L1-L3" class="git-link">Browse git</a>
<a href="https://github.com/annotation/text-fabric/blob/703d3977ff845baafe67bbbaa3a678e8deb2b911/tf/about/datasharing.py#L1-L3" class="git-link">Browse git</a>
</summary>
<pre><code class="python">&#34;&#34;&#34;
.. include:: ../docs/about/datasharing.md
Expand Down
2 changes: 1 addition & 1 deletion tf/about/displaydesign.html
Original file line number Diff line number Diff line change
Expand Up @@ -151,7 +151,7 @@ <h3 id="output">Output</h3>
<details class="source">
<summary>
<span>Expand source code</span>
<a href="https://github.com/annotation/text-fabric/blob/81c7208eecee1adac51470e747edd3781135e950/tf/about/displaydesign.py#L1-L3" class="git-link">Browse git</a>
<a href="https://github.com/annotation/text-fabric/blob/703d3977ff845baafe67bbbaa3a678e8deb2b911/tf/about/displaydesign.py#L1-L3" class="git-link">Browse git</a>
</summary>
<pre><code class="python">&#34;&#34;&#34;
.. include:: ../docs/about/displaydesign.md
Expand Down
2 changes: 1 addition & 1 deletion tf/about/faq.html
Original file line number Diff line number Diff line change
Expand Up @@ -161,7 +161,7 @@ <h3 id="github-rate-limit-exceeded">GitHub Rate Limit Exceeded!</h3>
<details class="source">
<summary>
<span>Expand source code</span>
<a href="https://github.com/annotation/text-fabric/blob/81c7208eecee1adac51470e747edd3781135e950/tf/about/faq.py#L1-L3" class="git-link">Browse git</a>
<a href="https://github.com/annotation/text-fabric/blob/703d3977ff845baafe67bbbaa3a678e8deb2b911/tf/about/faq.py#L1-L3" class="git-link">Browse git</a>
</summary>
<pre><code class="python">&#34;&#34;&#34;
.. include:: ../docs/about/faq.md
Expand Down
2 changes: 1 addition & 1 deletion tf/about/fileformats.html
Original file line number Diff line number Diff line change
Expand Up @@ -158,7 +158,7 @@ <h3 id="single-values">Single values</h3>
<details class="source">
<summary>
<span>Expand source code</span>
<a href="https://github.com/annotation/text-fabric/blob/81c7208eecee1adac51470e747edd3781135e950/tf/about/fileformats.py#L1-L3" class="git-link">Browse git</a>
<a href="https://github.com/annotation/text-fabric/blob/703d3977ff845baafe67bbbaa3a678e8deb2b911/tf/about/fileformats.py#L1-L3" class="git-link">Browse git</a>
</summary>
<pre><code class="python">&#34;&#34;&#34;
.. include:: ../docs/about/fileformats.md
Expand Down
2 changes: 1 addition & 1 deletion tf/about/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ <h1 id="documents">Documents</h1>
<details class="source">
<summary>
<span>Expand source code</span>
<a href="https://github.com/annotation/text-fabric/blob/81c7208eecee1adac51470e747edd3781135e950/tf/about/__init__.py#L1-L5" class="git-link">Browse git</a>
<a href="https://github.com/annotation/text-fabric/blob/703d3977ff845baafe67bbbaa3a678e8deb2b911/tf/about/__init__.py#L1-L5" class="git-link">Browse git</a>
</summary>
<pre><code class="python">&#34;&#34;&#34;
# Documents
Expand Down
2 changes: 1 addition & 1 deletion tf/about/install.html
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ <h4 id="note-for-linux-users">Note for Linux users</h4>
<details class="source">
<summary>
<span>Expand source code</span>
<a href="https://github.com/annotation/text-fabric/blob/81c7208eecee1adac51470e747edd3781135e950/tf/about/install.py#L1-L3" class="git-link">Browse git</a>
<a href="https://github.com/annotation/text-fabric/blob/703d3977ff845baafe67bbbaa3a678e8deb2b911/tf/about/install.py#L1-L3" class="git-link">Browse git</a>
</summary>
<pre><code class="python">&#34;&#34;&#34;
.. include:: ../docs/about/install.md
Expand Down
2 changes: 1 addition & 1 deletion tf/about/manual.html
Original file line number Diff line number Diff line change
Expand Up @@ -390,7 +390,7 @@ <h2 id="keyboard-shortcuts">Keyboard shortcuts</h2>
<details class="source">
<summary>
<span>Expand source code</span>
<a href="https://github.com/annotation/text-fabric/blob/81c7208eecee1adac51470e747edd3781135e950/tf/about/manual.py#L1-L3" class="git-link">Browse git</a>
<a href="https://github.com/annotation/text-fabric/blob/703d3977ff845baafe67bbbaa3a678e8deb2b911/tf/about/manual.py#L1-L3" class="git-link">Browse git</a>
</summary>
<pre><code class="python">&#34;&#34;&#34;
.. include:: ../docs/about/manual.md
Expand Down
2 changes: 1 addition & 1 deletion tf/about/optimizations.html
Original file line number Diff line number Diff line change
Expand Up @@ -187,7 +187,7 @@ <h3 id="edge-features">Edge features</h3>
<details class="source">
<summary>
<span>Expand source code</span>
<a href="https://github.com/annotation/text-fabric/blob/81c7208eecee1adac51470e747edd3781135e950/tf/about/optimizations.py#L1-L3" class="git-link">Browse git</a>
<a href="https://github.com/annotation/text-fabric/blob/703d3977ff845baafe67bbbaa3a678e8deb2b911/tf/about/optimizations.py#L1-L3" class="git-link">Browse git</a>
</summary>
<pre><code class="python">&#34;&#34;&#34;
.. include:: ../docs/about/optimizations.md
Expand Down
15 changes: 14 additions & 1 deletion tf/about/releases.html
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,18 @@ <h1 id="release-notes">Release notes</h1>
</code></pre>
<h2 id="12">12</h2>
<h3 id="124">12.4</h3>
<h4 id="1245">12.4.5</h4>
<p>2024-05-13</p>
<p>Fix in the autodownload by TF.
When TF downloads the <code>complete.zip</code> of a corpus and extracts it, it does not remove
previously exisiting files in the directories in which the data files land.
That pre-existing material can interfere in surprising ways with the resulting dataset,
as Christian Højgaard experienced (thanks Christian for reporting it and taking
the time to help me pinpoint the culprit).</p>
<p>The fix is that TF first inspects the <code>complete.zip</code> and determines what the
folders are in which the file <code>__checkout__.txt</code> exists. These are the folders
that do not tolerate pre-existing material. The will be deleted before extracting the
zip file.</p>
<h4 id="12434">12.4.3,4</h4>
<p>2024-05-08</p>
<ul>
Expand Down Expand Up @@ -396,7 +408,7 @@ <h2 id="older-releases">Older releases</h2>
<details class="source">
<summary>
<span>Expand source code</span>
<a href="https://github.com/annotation/text-fabric/blob/81c7208eecee1adac51470e747edd3781135e950/tf/about/releases.py#L1-L3" class="git-link">Browse git</a>
<a href="https://github.com/annotation/text-fabric/blob/703d3977ff845baafe67bbbaa3a678e8deb2b911/tf/about/releases.py#L1-L3" class="git-link">Browse git</a>
</summary>
<pre><code class="python">&#34;&#34;&#34;
.. include:: ../docs/about/releases.md
Expand Down Expand Up @@ -470,6 +482,7 @@ <h1>Index</h1>
<li><a href="#release-notes">Release notes</a><ul>
<li><a href="#12">12</a><ul>
<li><a href="#124">12.4</a><ul>
<li><a href="#1245">12.4.5</a></li>
<li><a href="#12434">12.4.3,4</a></li>
<li><a href="#1242">12.4.2</a></li>
<li><a href="#1241">12.4.1</a></li>
Expand Down
2 changes: 1 addition & 1 deletion tf/about/releasesold.html
Original file line number Diff line number Diff line change
Expand Up @@ -3430,7 +3430,7 @@ <h5 id="changed">Changed</h5>
<details class="source">
<summary>
<span>Expand source code</span>
<a href="https://github.com/annotation/text-fabric/blob/81c7208eecee1adac51470e747edd3781135e950/tf/about/releasesold.py#L1-L3" class="git-link">Browse git</a>
<a href="https://github.com/annotation/text-fabric/blob/703d3977ff845baafe67bbbaa3a678e8deb2b911/tf/about/releasesold.py#L1-L3" class="git-link">Browse git</a>
</summary>
<pre><code class="python">&#34;&#34;&#34;
.. include:: ../docs/about/releasesold.md
Expand Down
2 changes: 1 addition & 1 deletion tf/about/searchdesign.html
Original file line number Diff line number Diff line change
Expand Up @@ -477,7 +477,7 @@ <h3 id="small-first-strategy">Small-first strategy</h3>
<details class="source">
<summary>
<span>Expand source code</span>
<a href="https://github.com/annotation/text-fabric/blob/81c7208eecee1adac51470e747edd3781135e950/tf/about/searchdesign.py#L1-L3" class="git-link">Browse git</a>
<a href="https://github.com/annotation/text-fabric/blob/703d3977ff845baafe67bbbaa3a678e8deb2b911/tf/about/searchdesign.py#L1-L3" class="git-link">Browse git</a>
</summary>
<pre><code class="python">&#34;&#34;&#34;
.. include:: ../docs/about/searchdesign.md
Expand Down
2 changes: 1 addition & 1 deletion tf/about/searchusage.html
Original file line number Diff line number Diff line change
Expand Up @@ -776,7 +776,7 @@ <h5 id="implementation">Implementation</h5>
<details class="source">
<summary>
<span>Expand source code</span>
<a href="https://github.com/annotation/text-fabric/blob/81c7208eecee1adac51470e747edd3781135e950/tf/about/searchusage.py#L1-L3" class="git-link">Browse git</a>
<a href="https://github.com/annotation/text-fabric/blob/703d3977ff845baafe67bbbaa3a678e8deb2b911/tf/about/searchusage.py#L1-L3" class="git-link">Browse git</a>
</summary>
<pre><code class="python">&#34;&#34;&#34;
.. include:: ../docs/about/searchusage.md
Expand Down
2 changes: 1 addition & 1 deletion tf/about/tests.html
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ <h2 id="relations">Relations</h2>
<details class="source">
<summary>
<span>Expand source code</span>
<a href="https://github.com/annotation/text-fabric/blob/81c7208eecee1adac51470e747edd3781135e950/tf/about/tests.py#L1-L3" class="git-link">Browse git</a>
<a href="https://github.com/annotation/text-fabric/blob/703d3977ff845baafe67bbbaa3a678e8deb2b911/tf/about/tests.py#L1-L3" class="git-link">Browse git</a>
</summary>
<pre><code class="python">&#34;&#34;&#34;
.. include:: ../docs/about/tests.md
Expand Down
2 changes: 1 addition & 1 deletion tf/about/use.html
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ <h2 id="tf-api">TF API</h2>
<details class="source">
<summary>
<span>Expand source code</span>
<a href="https://github.com/annotation/text-fabric/blob/81c7208eecee1adac51470e747edd3781135e950/tf/about/use.py#L1-L3" class="git-link">Browse git</a>
<a href="https://github.com/annotation/text-fabric/blob/703d3977ff845baafe67bbbaa3a678e8deb2b911/tf/about/use.py#L1-L3" class="git-link">Browse git</a>
</summary>
<pre><code class="python">&#34;&#34;&#34;
.. include:: ../docs/about/use.md
Expand Down
2 changes: 1 addition & 1 deletion tf/about/usefunc.html
Original file line number Diff line number Diff line change
Expand Up @@ -419,7 +419,7 @@ <h2 id="prevent-data-loading">Prevent data loading</h2>
<details class="source">
<summary>
<span>Expand source code</span>
<a href="https://github.com/annotation/text-fabric/blob/81c7208eecee1adac51470e747edd3781135e950/tf/about/usefunc.py#L1-L3" class="git-link">Browse git</a>
<a href="https://github.com/annotation/text-fabric/blob/703d3977ff845baafe67bbbaa3a678e8deb2b911/tf/about/usefunc.py#L1-L3" class="git-link">Browse git</a>
</summary>
<pre><code class="python">&#34;&#34;&#34;
.. include:: ../docs/about/usefunc.md
Expand Down
2 changes: 1 addition & 1 deletion tf/about/variants.html
Original file line number Diff line number Diff line change
Expand Up @@ -438,7 +438,7 @@ <h3 id="the-stack">The stack</h3>
<details class="source">
<summary>
<span>Expand source code</span>
<a href="https://github.com/annotation/text-fabric/blob/81c7208eecee1adac51470e747edd3781135e950/tf/about/variants.py#L1-L3" class="git-link">Browse git</a>
<a href="https://github.com/annotation/text-fabric/blob/703d3977ff845baafe67bbbaa3a678e8deb2b911/tf/about/variants.py#L1-L3" class="git-link">Browse git</a>
</summary>
<pre><code class="python">&#34;&#34;&#34;
.. include:: ../docs/about/variants.md
Expand Down
2 changes: 1 addition & 1 deletion tf/about/volumes.html
Original file line number Diff line number Diff line change
Expand Up @@ -323,7 +323,7 @@ <h2 id="reflection">Reflection</h2>
<details class="source">
<summary>
<span>Expand source code</span>
<a href="https://github.com/annotation/text-fabric/blob/81c7208eecee1adac51470e747edd3781135e950/tf/about/volumes.py#L1-L3" class="git-link">Browse git</a>
<a href="https://github.com/annotation/text-fabric/blob/703d3977ff845baafe67bbbaa3a678e8deb2b911/tf/about/volumes.py#L1-L3" class="git-link">Browse git</a>
</summary>
<pre><code class="python">&#34;&#34;&#34;
.. include:: ../docs/about/volumes.md
Expand Down
6 changes: 3 additions & 3 deletions tf/advanced/annotate.html
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ <h1 class="title">Module <code>tf.advanced.annotate</code></h1>
<details class="source">
<summary>
<span>Expand source code</span>
<a href="https://github.com/annotation/text-fabric/blob/81c7208eecee1adac51470e747edd3781135e950/tf/advanced/annotate.py#L1-L26" class="git-link">Browse git</a>
<a href="https://github.com/annotation/text-fabric/blob/703d3977ff845baafe67bbbaa3a678e8deb2b911/tf/advanced/annotate.py#L1-L26" class="git-link">Browse git</a>
</summary>
<pre><code class="python">&#34;&#34;&#34;
Enable manual annotation APIs.
Expand Down Expand Up @@ -84,7 +84,7 @@ <h2 id="parameters">Parameters</h2>
<details class="source">
<summary>
<span>Expand source code</span>
<a href="https://github.com/annotation/text-fabric/blob/81c7208eecee1adac51470e747edd3781135e950/tf/advanced/annotate.py#L17-L26" class="git-link">Browse git</a>
<a href="https://github.com/annotation/text-fabric/blob/703d3977ff845baafe67bbbaa3a678e8deb2b911/tf/advanced/annotate.py#L17-L26" class="git-link">Browse git</a>
</summary>
<pre><code class="python">def annotateApi(app):
&#34;&#34;&#34;Produce the interchange functions API.
Expand All @@ -106,7 +106,7 @@ <h2 id="parameters">Parameters</h2>
<details class="source">
<summary>
<span>Expand source code</span>
<a href="https://github.com/annotation/text-fabric/blob/81c7208eecee1adac51470e747edd3781135e950/tf/advanced/annotate.py#L13-L14" class="git-link">Browse git</a>
<a href="https://github.com/annotation/text-fabric/blob/703d3977ff845baafe67bbbaa3a678e8deb2b911/tf/advanced/annotate.py#L13-L14" class="git-link">Browse git</a>
</summary>
<pre><code class="python">def makeNer(app):
return NER(app)</code></pre>
Expand Down
Loading

0 comments on commit c48cd47

Please sign in to comment.