Merge pull request #34 from AlexanderWillner/main

started to remove lints (documentation can/should be improved)

Author: AlexanderWillner

.coveragerc

@@ -3,9 +3,6 @@
 exclude_lines =
     if __name__ == .__main__.:
 
-[run]
-    relative_files = True
-
 omit =
     setup.py
     */__init__.py

things/api.py

@@ -386,17 +386,32 @@ def get(uuid, default=None, **kwargs):
 
 
 def todos(uuid=None, **kwargs):
+    """
+    Read to-dos into dicts.
+
+    See `things.tasks` for details.
+    """
     return tasks(uuid=uuid, type="to-do", **kwargs)
 
 
 def projects(uuid=None, **kwargs):
+    """
+    Read projects into dicts.
+
+    See `things.tasks` for details.
+    """
     return tasks(uuid=uuid, type="project", **kwargs)
 
 
 # Filter by collections in the Things app sidebar.
 
 
 def inbox(**kwargs):
+    """
+    Read inbox into dicts.
+
+    See `things.tasks` for details.
+    """
     return tasks(start="Inbox", **kwargs)
 
 
@@ -434,14 +449,29 @@ def upcoming(**kwargs):
 
 
 def anytime(**kwargs):
+    """
+    Read anytime tasks into dicts.
+
+    See `things.tasks` for details.
+    """
     return tasks(start="Anytime", **kwargs)
 
 
 def someday(**kwargs):
+    """
+    Read someday tasks into dicts.
+
+    See `things.tasks` for details.
+    """
     return tasks(start_date=False, start="Someday", **kwargs)
 
 
 def logbook(**kwargs):
+    """
+    Read logbook tasks into dicts.
+
+    See `things.tasks` for details.
+    """
     result = [*canceled(**kwargs), *completed(**kwargs)]
     result.sort(key=lambda task: task["stop_date"], reverse=True)
     return result
@@ -451,6 +481,11 @@ def logbook(**kwargs):
 
 
 def canceled(**kwargs):
+    """
+    Read canceled tasks into dicts.
+
+    See `things.tasks` for details.
+    """
     return tasks(status="canceled", **kwargs)
 
 
@@ -467,6 +502,11 @@ def completed(**kwargs):
 
 
 def deadlines(**kwargs):
+    """
+    Read tasks with deadlines into dicts.
+
+    See `things.tasks` for details.
+    """
     result = tasks(deadline=True, **kwargs)
     result.sort(key=lambda task: task["deadline"])
     return result
@@ -476,6 +516,10 @@ def deadlines(**kwargs):
 
 
 def link(uuid):
+    """
+    Returns a things:///show?id=uuid link.
+    """
+
     return f"things:///show?id={uuid}"
 
 

things/database.py

@@ -530,7 +530,7 @@ def get_daystats(self):
                          "+" || x || " days") as date,
                     CREATED.TasksCreated as created,
                     CLOSED.TasksClosed as completed,
-                    CANCELLED.TasksCanceled as canceled,
+                    CANCELED.TasksCanceled as canceled,
                     TRASHED.TasksTrashed as trashed
                 FROM timeseries
                 LEFT JOIN
@@ -548,7 +548,7 @@ def get_daystats(self):
                         WHERE DAY NOT NULL
                           AND TASK.{self.IS_CANCELED} AND TASK.{self.IS_TODO}
                         GROUP BY DAY)
-                        AS CANCELLED ON CANCELLED.DAY = date
+                        AS CANCELED ON CANCELED.DAY = date
                 LEFT JOIN
                     (SELECT COUNT(uuid) AS TasksTrashed,
                         date({self.DATE_MOD},"unixepoch") AS DAY