add: docs stubs for entity-related methods on the client

- also tried to make the docstrings a bit clearer

docs/entities.md

@@ -0,0 +1,3 @@
+# Entities
+
+::: pyodk._endpoints.entities.EntityService

docs/entity_lists.md

@@ -0,0 +1,3 @@
+# Entity Lists
+
+::: pyodk._endpoints.entity_lists.EntityListService

mkdocs.yml

@@ -11,9 +11,11 @@ watch:
 nav:
     - Overview: index.md
     - Client: client.md
+    - .entities: entities.md
+    - .entity_lists: entity_lists.md
     - .forms: forms.md
-    - .submissions: submissions.md
     - .projects: projects.md
+    - .submissions: submissions.md
     - HTTP methods: http-methods.md
     - Examples: examples/README.md
 

pyodk/_endpoints/entities.py

@@ -50,7 +50,9 @@ class EntityService(bases.Service):
     data = client.entities.list()
     ```
 
-    An EntityList is a list of Entities, e.g. `list[Entity]`.
+    Conceptually, an Entity's parent object is an EntityList. Each EntityList may
+    have multiple Entities. In Python parlance, EntityLists are like classes, while
+    Entities are like instances.
     """
 
     __slots__ = ("urls", "session", "default_project_id", "default_entity_list_name")

pyodk/_endpoints/entity_lists.py

@@ -36,12 +36,8 @@ class EntityListService(bases.Service):
     data = client.entity_lists.list()
     ```
 
-    The structure this class works with is conceptually a list of lists, e.g.
-
-    ```
-    EntityList = list[Entity]
-    self.list() = list[EntityList]
-    ```
+    Conceptually, an EntityList's parent object is a Project. Each Project may have
+    multiple EntityLists.
     """
 
     __slots__ = ("urls", "session", "default_project_id")