Fix minor typos

Problem:
Spelling errors ...

Solution:
Fix spelling errors and some syntax errors in docs

Signed-off-by: Paul Hewlett <phewlett76@gmail.com>

Author: eccles

archivist/access_policies.py

@@ -17,7 +17,7 @@
           "https://rkvst.poc.jitsuin.io",
           auth=authtoken,
       )
-      asset = arch.access_policies.create(...)
+      access_policy = arch.access_policies.create(...)
 
 """
 
@@ -32,6 +32,9 @@
 
 from .assets import Asset
 
+#: Default page size - number of entities fetched in one REST GET in the
+#: :func:`~_AccessPoliciesClient.list` method. This can be overridden but should rarely
+#: be changed.
 DEFAULT_PAGE_SIZE = 500
 
 
@@ -182,7 +185,7 @@ def list(
     ):
         """List access policies.
 
-        List access policiess that match criteria.
+        List access policies that match criteria.
 
         Args:
             display_name (str): display name (optional0

archivist/archivist.py

@@ -7,7 +7,8 @@
 
    The REST methods in this class should only be used directly when
    a CRUD endpoint for the specific type of entity is unavaliable.
-   Current CRUD endpoints are assets, events, locations and attachments.
+   Current CRUD endpoints are assets, events, locations, attachments.
+   IAM subjects and IAM access policies.
 
    Instantiation of this class encapsulates the URL and authentication
    parameters:
@@ -23,8 +24,8 @@
           auth=authtoken,
       )
 
-    The arch variable now has additonal endpoints assets,events,locations and
-    attachments documented elsewhere.
+    The arch variable now has additonal endpoints assets,events,locations,
+    attachments, IAM subjects and IAM access policies documented elsewhere.
 
 """
 

archivist/assets.py

@@ -30,8 +30,9 @@
 from .confirm import wait_for_confirmation, wait_for_confirmed
 
 
-#: Default page size - number of entities fetched in one call to the
-#: :func:`~_AssetsClient.list` method.
+#: Default page size - number of entities fetched in one REST GET in the
+#: :func:`~_AssetsClient.list` method. This can be overridden but should rarely
+#: be changed.
 DEFAULT_PAGE_SIZE = 500
 
 

archivist/attachments.py

@@ -17,7 +17,8 @@
           "https://rkvst.poc.jitsuin.io",
           auth=authtoken,
       )
-      attachment = arch.attachments.create(...)
+      with open("something.jpg") as fd:
+          attachment = arch.attachments.upload(fd)
 
 """
 
@@ -46,7 +47,7 @@ def upload(self, fd, *, mtype="image/jpg"):
         Creates attachment from opened file or other data source.
 
         Args:
-            fd (file): opened file escriptor or other file-type iterable.
+            fd (file): opened file descriptor or other file-type iterable.
             mtype (str): mimetype of data.
 
         Returns:

archivist/errors.py

@@ -8,7 +8,7 @@
 
 
 class ArchivistError(Exception):
-    """Base exception fot=r archivist package"""
+    """Base exception for archivist package"""
 
 
 class ArchivistBadFieldError(ArchivistError):

archivist/events.py

@@ -33,8 +33,9 @@
 from .confirm import wait_for_confirmation, wait_for_confirmed
 
 
-#: Default page size - number of entities fetched in one call to the
-#: :func:`~_EventsClient.list` method.
+#: Default page size - number of entities fetched in one REST GET in the
+#: :func:`~_EventsClient.list` method. This can be overridden but should rarely
+#: be changed.
 DEFAULT_PAGE_SIZE = 500
 
 

archivist/locations.py

@@ -25,8 +25,9 @@
 from .constants import LOCATIONS_SUBPATH, LOCATIONS_LABEL
 
 
-#: Default page size - number of entities fetched in one call to the
-#: :func:`~_LocationsClient.list` method.
+#: Default page size - number of entities fetched in one REST GET in the
+#: :func:`~_LocationsClient.list` method. This can be overridden but should rarely
+#: be changed.
 DEFAULT_PAGE_SIZE = 500
 
 

archivist/subjects.py

@@ -17,7 +17,7 @@
           "https://rkvst.poc.jitsuin.io",
           auth=authtoken,
       )
-      asset = arch.subjects.create(...)
+      subject = arch.subjects.create(...)
 
 """
 
@@ -26,6 +26,9 @@
     SUBJECTS_LABEL,
 )
 
+#: Default page size - number of entities fetched in one REST GET in the
+#: :func:`~_SubjectsClient.list` method. This can be overridden but should rarely
+#: be changed.
 DEFAULT_PAGE_SIZE = 500
 
 

docs/introduction.rst

@@ -27,4 +27,4 @@ REST api (in any language):
     *  fully unittested - 100% coverage.
     *  code style managed and enforced. 
 
-See the **examples/** directory for code that creates assets and events and lists them.
+See the **examples/** directory for example code.