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

Author: AlexanderWillner

things/api.py

@@ -386,17 +386,32 @@ def get(uuid, default=None, **kwargs):
 
 
 def todos(uuid=None, **kwargs):
+    """
+    Read to-dos into dicts.
+
+    See `api.tasks` for details.
+    """
     return tasks(uuid=uuid, type="to-do", **kwargs)
 
 
 def projects(uuid=None, **kwargs):
+    """
+    Read projects into dicts.
+
+    See `api.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 `api.tasks` for details.
+    """
     return tasks(start="Inbox", **kwargs)
 
 
@@ -434,14 +449,29 @@ def upcoming(**kwargs):
 
 
 def anytime(**kwargs):
+    """
+    Read anytime to-dos into dicts.
+
+    See `api.tasks` for details.
+    """
     return tasks(start="Anytime", **kwargs)
 
 
 def someday(**kwargs):
+    """
+    Read someday to-dos into dicts.
+
+    See `api.tasks` for details.
+    """
     return tasks(start_date=False, start="Someday", **kwargs)
 
 
 def logbook(**kwargs):
+    """
+    Read logbook to-dos into dicts.
+
+    See `api.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 cancelled to-dos into dicts.
+
+    See `api.tasks` for details.
+    """
     return tasks(status="canceled", **kwargs)
 
 
@@ -467,6 +502,11 @@ def completed(**kwargs):
 
 
 def due(**kwargs):
+    """
+    Read due to-dos into dicts.
+
+    See `api.tasks` for details.
+    """
     result = tasks(due_date=True, **kwargs)
     result.sort(key=lambda task: task["due_date"])
     return result
@@ -476,6 +516,10 @@ def due(**kwargs):
 
 
 def link(uuid):
+    """
+    Returns a things:///show?id=uuid link.
+    """
+
     return f"things:///show?id={uuid}"