Updated docs

Author: github-actions[bot]

docs/things.html

@@ -82,6 +82,7 @@ <h1 class="modulename">
     <span class="n">today</span><span class="p">,</span>
     <span class="n">todos</span><span class="p">,</span>
     <span class="n">token</span><span class="p">,</span>
+    <span class="n">trash</span><span class="p">,</span>
     <span class="n">upcoming</span><span class="p">,</span>
 <span class="p">)</span>
 <span class="kn">from</span> <span class="nn">things.database</span> <span class="kn">import</span> <span class="n">Database</span>  <span class="c1"># noqa</span>

docs/things/api.html

@@ -69,6 +69,9 @@ <h2>API Documentation</h2>
             <li>
                     <a class="function" href="#logbook">logbook</a>
             </li>
+            <li>
+                    <a class="function" href="#trash">trash</a>
+            </li>
             <li>
                     <a class="function" href="#canceled">canceled</a>
             </li>
@@ -218,6 +221,11 @@ <h1 class="modulename">
 <span class="sd">        - `deadline == True`, only include tasks _with_ a deadline.</span>
 <span class="sd">        - `deadline == None` (default), then include all tasks.</span>
 
+<span class="sd">    trashed : bool or None, optional</span>
+<span class="sd">        - `trashed == True`, only include trashed tasks.</span>
+<span class="sd">        - `trashed == False`, (default), only include non-trashed tasks.</span>
+<span class="sd">        - `trashed == None`, include both kind of tasks.</span>
+
 <span class="sd">    last : str, optional</span>
 <span class="sd">        Limit returned tasks to tasks created within the last X days,</span>
 <span class="sd">        weeks, or years. For example: &#39;3d&#39;, &#39;5w&#39;, or &#39;1y&#39;.</span>
@@ -588,7 +596,7 @@ <h1 class="modulename">
 <span class="sd">    See `things.api.tasks` for details on the optional parameters.</span>
 <span class="sd">    &quot;&quot;&quot;</span>
     <span class="n">database</span> <span class="o">=</span> <span class="n">pop_database</span><span class="p">(</span><span class="n">kwargs</span><span class="p">)</span>
-    <span class="k">if</span> <span class="ow">not</span> <span class="n">database</span><span class="o">.</span><span class="n">was_modified_today</span><span class="p">():</span>
+    <span class="k">if</span> <span class="ow">not</span> <span class="n">database</span><span class="o">.</span><span class="n">was_modified_today</span><span class="p">():</span>  <span class="c1"># pragma: no cover</span>
         <span class="nb">print</span><span class="p">(</span>
             <span class="s2">&quot;[NOTE] The results reflect the state of the Things app &quot;</span>
             <span class="s2">&quot;when it was last run. If the results seem out of date, &quot;</span>
@@ -646,6 +654,15 @@ <h1 class="modulename">
     <span class="k">return</span> <span class="n">result</span>
 
 
+<span class="k">def</span> <span class="nf">trash</span><span class="p">(</span><span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
+    <span class="sd">&quot;&quot;&quot;</span>
+<span class="sd">    Read Trash tasks into dicts.</span>
+
+<span class="sd">    See `things.api.tasks` for details on the optional parameters.</span>
+<span class="sd">    &quot;&quot;&quot;</span>
+    <span class="k">return</span> <span class="n">tasks</span><span class="p">(</span><span class="n">trashed</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">status</span><span class="o">=</span><span class="n">kwargs</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="s2">&quot;status&quot;</span><span class="p">,</span> <span class="kc">None</span><span class="p">),</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
+
+
 <span class="c1"># Filter by various task properties</span>
 
 
@@ -761,8 +778,8 @@ <h1 class="modulename">
 <span class="sd">    &gt;&gt;&gt; tag = things.tags(&#39;Home&#39;)</span>
 <span class="sd">    &gt;&gt;&gt; things.show(tag[&#39;uuid&#39;])</span>
 <span class="sd">    &quot;&quot;&quot;</span>
-    <span class="n">uri</span> <span class="o">=</span> <span class="n">link</span><span class="p">(</span><span class="n">uuid</span><span class="p">)</span>
-    <span class="n">os</span><span class="o">.</span><span class="n">system</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;open </span><span class="si">{</span><span class="n">quote</span><span class="p">(</span><span class="n">uri</span><span class="p">)</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span>
+    <span class="n">uri</span> <span class="o">=</span> <span class="n">link</span><span class="p">(</span><span class="n">uuid</span><span class="p">)</span>  <span class="c1"># pragma: no cover</span>
+    <span class="n">os</span><span class="o">.</span><span class="n">system</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;open </span><span class="si">{</span><span class="n">quote</span><span class="p">(</span><span class="n">uri</span><span class="p">)</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span>  <span class="c1"># pragma: no cover</span>
 
 
 <span class="c1"># Helper functions</span>
@@ -868,6 +885,11 @@ <h1 class="modulename">
 <span class="sd">        - `deadline == True`, only include tasks _with_ a deadline.</span>
 <span class="sd">        - `deadline == None` (default), then include all tasks.</span>
 
+<span class="sd">    trashed : bool or None, optional</span>
+<span class="sd">        - `trashed == True`, only include trashed tasks.</span>
+<span class="sd">        - `trashed == False`, (default), only include non-trashed tasks.</span>
+<span class="sd">        - `trashed == None`, include both kind of tasks.</span>
+
 <span class="sd">    last : str, optional</span>
 <span class="sd">        Limit returned tasks to tasks created within the last X days,</span>
 <span class="sd">        weeks, or years. For example: &#39;3d&#39;, &#39;5w&#39;, or &#39;1y&#39;.</span>
@@ -1055,6 +1077,12 @@ <h6 id="parameters">Parameters</h6>
 <li><code>deadline == True</code>, only include tasks _with_ a deadline.</li>
 <li><code>deadline == None</code> (default), then include all tasks.</li>
 </ul></li>
+<li><strong>trashed</strong> (bool or None, optional):
+<ul>
+<li><code>trashed == True</code>, only include trashed tasks.</li>
+<li><code>trashed == False</code>, (default), only include non-trashed tasks.</li>
+<li><code>trashed == None</code>, include both kind of tasks.</li>
+</ul></li>
 <li><p><strong>last</strong> (str, optional):
 Limit returned tasks to tasks created within the last X days,
 weeks, or years. For example: '3d', '5w', or '1y'.</p>
@@ -1642,7 +1670,7 @@ <h6 id="examples">Examples</h6>
 <span class="sd">    See `things.api.tasks` for details on the optional parameters.</span>
 <span class="sd">    &quot;&quot;&quot;</span>
     <span class="n">database</span> <span class="o">=</span> <span class="n">pop_database</span><span class="p">(</span><span class="n">kwargs</span><span class="p">)</span>
-    <span class="k">if</span> <span class="ow">not</span> <span class="n">database</span><span class="o">.</span><span class="n">was_modified_today</span><span class="p">():</span>
+    <span class="k">if</span> <span class="ow">not</span> <span class="n">database</span><span class="o">.</span><span class="n">was_modified_today</span><span class="p">():</span>  <span class="c1"># pragma: no cover</span>
         <span class="nb">print</span><span class="p">(</span>
             <span class="s2">&quot;[NOTE] The results reflect the state of the Things app &quot;</span>
             <span class="s2">&quot;when it was last run. If the results seem out of date, &quot;</span>
@@ -1792,6 +1820,34 @@ <h6 id="examples">Examples</h6>
 </div>
 
 
+                </section>
+                <section id="trash">
+                            <div class="attr function"><a class="headerlink" href="#trash">#&nbsp;&nbsp</a>
+
+        
+            <span class="def">def</span>
+            <span class="name">trash</span><span class="signature">(**kwargs)</span>:
+    </div>
+
+                <details>
+            <summary>View Source</summary>
+            <div class="codehilite"><pre><span></span><span class="k">def</span> <span class="nf">trash</span><span class="p">(</span><span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
+    <span class="sd">&quot;&quot;&quot;</span>
+<span class="sd">    Read Trash tasks into dicts.</span>
+
+<span class="sd">    See `things.api.tasks` for details on the optional parameters.</span>
+<span class="sd">    &quot;&quot;&quot;</span>
+    <span class="k">return</span> <span class="n">tasks</span><span class="p">(</span><span class="n">trashed</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">status</span><span class="o">=</span><span class="n">kwargs</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="s2">&quot;status&quot;</span><span class="p">,</span> <span class="kc">None</span><span class="p">),</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
+</pre></div>
+
+        </details>
+
+            <div class="docstring"><p>Read Trash tasks into dicts.</p>
+
+<p>See <code><a href="#tasks">things.api.tasks</a></code> for details on the optional parameters.</p>
+</div>
+
+
                 </section>
                 <section id="canceled">
                             <div class="attr function"><a class="headerlink" href="#canceled">#&nbsp;&nbsp</a>
@@ -2061,8 +2117,8 @@ <h6 id="examples">Examples</h6>
 <span class="sd">    &gt;&gt;&gt; tag = things.tags(&#39;Home&#39;)</span>
 <span class="sd">    &gt;&gt;&gt; things.show(tag[&#39;uuid&#39;])</span>
 <span class="sd">    &quot;&quot;&quot;</span>
-    <span class="n">uri</span> <span class="o">=</span> <span class="n">link</span><span class="p">(</span><span class="n">uuid</span><span class="p">)</span>
-    <span class="n">os</span><span class="o">.</span><span class="n">system</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;open </span><span class="si">{</span><span class="n">quote</span><span class="p">(</span><span class="n">uri</span><span class="p">)</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span>
+    <span class="n">uri</span> <span class="o">=</span> <span class="n">link</span><span class="p">(</span><span class="n">uuid</span><span class="p">)</span>  <span class="c1"># pragma: no cover</span>
+    <span class="n">os</span><span class="o">.</span><span class="n">system</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;open </span><span class="si">{</span><span class="n">quote</span><span class="p">(</span><span class="n">uri</span><span class="p">)</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span>  <span class="c1"># pragma: no cover</span>
 </pre></div>
 
         </details>