Skip to content

Commit f94461c

Browse files
Updated docs
1 parent 9173331 commit f94461c

File tree

2 files changed

+25
-25
lines changed

2 files changed

+25
-25
lines changed

docs/things/api.html

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -620,11 +620,11 @@ <h1 class="modulename">
620620
<span class="sd"> Read Today&#39;s tasks into dicts.</span>
621621

622622
<span class="sd"> Note: The Things database reflects the state of the Things app when</span>
623-
<span class="sd"> it was last opened. For the Today to-dos that means the database</span>
623+
<span class="sd"> it was last opened. For the Today tasks that means the database</span>
624624
<span class="sd"> might not be up to date anymore if you didn&#39;t open the app recently.</span>
625625
<span class="sd"> To get around this limitation, we here make a prediction of what</span>
626-
<span class="sd"> to-dos would show up in Today if you were to open the app right now.</span>
627-
<span class="sd"> This prediction does currently not include repeating to-dos.</span>
626+
<span class="sd"> tasks would show up in Today if you were to open the app right now.</span>
627+
<span class="sd"> This prediction does not include repeating to-dos at this time.</span>
628628

629629
<span class="sd"> See `things.api.tasks` for details on the optional parameters.</span>
630630
<span class="sd"> &quot;&quot;&quot;</span>
@@ -1775,11 +1775,11 @@ <h6 id="examples">Examples</h6>
17751775
<span class="sd"> Read Today&#39;s tasks into dicts.</span>
17761776

17771777
<span class="sd"> Note: The Things database reflects the state of the Things app when</span>
1778-
<span class="sd"> it was last opened. For the Today to-dos that means the database</span>
1778+
<span class="sd"> it was last opened. For the Today tasks that means the database</span>
17791779
<span class="sd"> might not be up to date anymore if you didn&#39;t open the app recently.</span>
17801780
<span class="sd"> To get around this limitation, we here make a prediction of what</span>
1781-
<span class="sd"> to-dos would show up in Today if you were to open the app right now.</span>
1782-
<span class="sd"> This prediction does currently not include repeating to-dos.</span>
1781+
<span class="sd"> tasks would show up in Today if you were to open the app right now.</span>
1782+
<span class="sd"> This prediction does not include repeating to-dos at this time.</span>
17831783

17841784
<span class="sd"> See `things.api.tasks` for details on the optional parameters.</span>
17851785
<span class="sd"> &quot;&quot;&quot;</span>
@@ -1821,11 +1821,11 @@ <h6 id="examples">Examples</h6>
18211821
<div class="docstring"><p>Read Today's tasks into dicts.</p>
18221822

18231823
<p>Note: The Things database reflects the state of the Things app when
1824-
it was last opened. For the Today to-dos that means the database
1824+
it was last opened. For the Today tasks that means the database
18251825
might not be up to date anymore if you didn't open the app recently.
18261826
To get around this limitation, we here make a prediction of what
1827-
to-dos would show up in Today if you were to open the app right now.
1828-
This prediction does currently not include repeating to-dos.</p>
1827+
tasks would show up in Today if you were to open the app right now.
1828+
This prediction does not include repeating to-dos at this time.</p>
18291829

18301830
<p>See <code><a href="#tasks">things.api.tasks</a></code> for details on the optional parameters.</p>
18311831
</div>

docs/things/database.html

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -815,9 +815,9 @@ <h1 class="modulename">
815815
<span class="sd"> Name of the column that has date information on a task.</span>
816816

817817
<span class="sd"> offset : str or None</span>
818-
<span class="sd"> A string comprised either of an integer and a single character</span>
819-
<span class="sd"> that can be &#39;d&#39;, &#39;w&#39;, or &#39;y&#39; that determines whether to return</span>
820-
<span class="sd"> all tasks for the past X days, weeks, or years.</span>
818+
<span class="sd"> A string comprised of an integer and a single character that can</span>
819+
<span class="sd"> be &#39;d&#39;, &#39;w&#39;, or &#39;y&#39; that determines whether to return all tasks</span>
820+
<span class="sd"> for the past X days, weeks, or years.</span>
821821

822822
<span class="sd"> Returns</span>
823823
<span class="sd"> -------</span>
@@ -828,7 +828,7 @@ <h1 class="modulename">
828828
<span class="sd"> Examples</span>
829829
<span class="sd"> --------</span>
830830
<span class="sd"> &gt;&gt;&gt; make_date_range_filter(&#39;created&#39;, &#39;3d&#39;)</span>
831-
<span class="sd"> &quot;AND datetime(created, &#39;unixepoch&#39;, &#39;localtime&#39;) &gt; datetime(&#39;now&#39;, &#39;-3 days&#39;)&quot;</span>
831+
<span class="sd"> &quot;AND datetime(created, &#39;unixepoch&#39;) &gt; datetime(&#39;now&#39;, &#39;-3 days&#39;)&quot;</span>
832832

833833
<span class="sd"> &gt;&gt;&gt; make_date_range_filter(&#39;created&#39;, None)</span>
834834
<span class="sd"> &#39;&#39;</span>
@@ -846,8 +846,8 @@ <h1 class="modulename">
846846
<span class="k">elif</span> <span class="n">suffix</span> <span class="o">==</span> <span class="s2">&quot;y&quot;</span><span class="p">:</span>
847847
<span class="n">modifier</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">&quot;-</span><span class="si">{</span><span class="n">number</span><span class="si">}</span><span class="s2"> years&quot;</span>
848848

849-
<span class="n">column_datetime</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">&quot;datetime(</span><span class="si">{</span><span class="n">date_column</span><span class="si">}</span><span class="s2">, &#39;unixepoch&#39;, &#39;localtime&#39;)&quot;</span>
850-
<span class="n">offset_datetime</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">&quot;datetime(&#39;now&#39;, &#39;localtime&#39;, &#39;</span><span class="si">{</span><span class="n">modifier</span><span class="si">}</span><span class="s2">&#39;)&quot;</span>
849+
<span class="n">column_datetime</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">&quot;datetime(</span><span class="si">{</span><span class="n">date_column</span><span class="si">}</span><span class="s2">, &#39;unixepoch&#39;)&quot;</span>
850+
<span class="n">offset_datetime</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">&quot;datetime(&#39;now&#39;, &#39;</span><span class="si">{</span><span class="n">modifier</span><span class="si">}</span><span class="s2">&#39;)&quot;</span>
851851

852852
<span class="k">return</span> <span class="sa">f</span><span class="s2">&quot;AND </span><span class="si">{</span><span class="n">column_datetime</span><span class="si">}</span><span class="s2"> &gt; </span><span class="si">{</span><span class="n">offset_datetime</span><span class="si">}</span><span class="s2">&quot;</span>
853853

@@ -2306,9 +2306,9 @@ <h6 id="examples">Examples</h6>
23062306
<span class="sd"> Name of the column that has date information on a task.</span>
23072307

23082308
<span class="sd"> offset : str or None</span>
2309-
<span class="sd"> A string comprised either of an integer and a single character</span>
2310-
<span class="sd"> that can be &#39;d&#39;, &#39;w&#39;, or &#39;y&#39; that determines whether to return</span>
2311-
<span class="sd"> all tasks for the past X days, weeks, or years.</span>
2309+
<span class="sd"> A string comprised of an integer and a single character that can</span>
2310+
<span class="sd"> be &#39;d&#39;, &#39;w&#39;, or &#39;y&#39; that determines whether to return all tasks</span>
2311+
<span class="sd"> for the past X days, weeks, or years.</span>
23122312

23132313
<span class="sd"> Returns</span>
23142314
<span class="sd"> -------</span>
@@ -2319,7 +2319,7 @@ <h6 id="examples">Examples</h6>
23192319
<span class="sd"> Examples</span>
23202320
<span class="sd"> --------</span>
23212321
<span class="sd"> &gt;&gt;&gt; make_date_range_filter(&#39;created&#39;, &#39;3d&#39;)</span>
2322-
<span class="sd"> &quot;AND datetime(created, &#39;unixepoch&#39;, &#39;localtime&#39;) &gt; datetime(&#39;now&#39;, &#39;-3 days&#39;)&quot;</span>
2322+
<span class="sd"> &quot;AND datetime(created, &#39;unixepoch&#39;) &gt; datetime(&#39;now&#39;, &#39;-3 days&#39;)&quot;</span>
23232323

23242324
<span class="sd"> &gt;&gt;&gt; make_date_range_filter(&#39;created&#39;, None)</span>
23252325
<span class="sd"> &#39;&#39;</span>
@@ -2337,8 +2337,8 @@ <h6 id="examples">Examples</h6>
23372337
<span class="k">elif</span> <span class="n">suffix</span> <span class="o">==</span> <span class="s2">&quot;y&quot;</span><span class="p">:</span>
23382338
<span class="n">modifier</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">&quot;-</span><span class="si">{</span><span class="n">number</span><span class="si">}</span><span class="s2"> years&quot;</span>
23392339

2340-
<span class="n">column_datetime</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">&quot;datetime(</span><span class="si">{</span><span class="n">date_column</span><span class="si">}</span><span class="s2">, &#39;unixepoch&#39;, &#39;localtime&#39;)&quot;</span>
2341-
<span class="n">offset_datetime</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">&quot;datetime(&#39;now&#39;, &#39;localtime&#39;, &#39;</span><span class="si">{</span><span class="n">modifier</span><span class="si">}</span><span class="s2">&#39;)&quot;</span>
2340+
<span class="n">column_datetime</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">&quot;datetime(</span><span class="si">{</span><span class="n">date_column</span><span class="si">}</span><span class="s2">, &#39;unixepoch&#39;)&quot;</span>
2341+
<span class="n">offset_datetime</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">&quot;datetime(&#39;now&#39;, &#39;</span><span class="si">{</span><span class="n">modifier</span><span class="si">}</span><span class="s2">&#39;)&quot;</span>
23422342

23432343
<span class="k">return</span> <span class="sa">f</span><span class="s2">&quot;AND </span><span class="si">{</span><span class="n">column_datetime</span><span class="si">}</span><span class="s2"> &gt; </span><span class="si">{</span><span class="n">offset_datetime</span><span class="si">}</span><span class="s2">&quot;</span>
23442344
</pre></div>
@@ -2353,9 +2353,9 @@ <h6 id="parameters">Parameters</h6>
23532353
<li><strong>date_column</strong> (str):
23542354
Name of the column that has date information on a task.</li>
23552355
<li><strong>offset</strong> (str or None):
2356-
A string comprised either of an integer and a single character
2357-
that can be 'd', 'w', or 'y' that determines whether to return
2358-
all tasks for the past X days, weeks, or years.</li>
2356+
A string comprised of an integer and a single character that can
2357+
be 'd', 'w', or 'y' that determines whether to return all tasks
2358+
for the past X days, weeks, or years.</li>
23592359
</ul>
23602360

23612361
<h6 id="returns">Returns</h6>
@@ -2368,7 +2368,7 @@ <h6 id="returns">Returns</h6>
23682368
<h6 id="examples">Examples</h6>
23692369

23702370
<div class="codehilite"><pre><span></span><code><span class="gp">&gt;&gt;&gt; </span><span class="n">make_date_range_filter</span><span class="p">(</span><span class="s1">&#39;created&#39;</span><span class="p">,</span> <span class="s1">&#39;3d&#39;</span><span class="p">)</span>
2371-
<span class="go">&quot;AND datetime(created, &#39;unixepoch&#39;, &#39;localtime&#39;) &gt; datetime(&#39;now&#39;, &#39;-3 days&#39;)&quot;</span>
2371+
<span class="go">&quot;AND datetime(created, &#39;unixepoch&#39;) &gt; datetime(&#39;now&#39;, &#39;-3 days&#39;)&quot;</span>
23722372
</code></pre></div>
23732373

23742374
<div class="codehilite"><pre><span></span><code><span class="gp">&gt;&gt;&gt; </span><span class="n">make_date_range_filter</span><span class="p">(</span><span class="s1">&#39;created&#39;</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>

0 commit comments

Comments
 (0)