Merge pull request #298 from mesozoic/docfix

Fix docs typos
gtalarico · Aug 18, 2023 · 913da8b · 913da8b
2 parents 1d4ecbd + b8782fe
commit 913da8b
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 4 deletions.
diff --git a/pyairtable/api/api.py b/pyairtable/api/api.py
@@ -24,7 +24,8 @@ class Api:
 
     Usage:
         >>> api = Api('auth_token')
-        >>> api.all('base_id', 'table_name')
+        >>> table = api.table('base_id', 'table_name')
+        >>> records = table.all()
     """
 
     VERSION = "v0"

diff --git a/pyairtable/api/table.py b/pyairtable/api/table.py
@@ -185,9 +185,10 @@ def all(self, **options: Any) -> List[RecordDict]:
         """
         Retrieves all matching records in a single list.
 
-        >>> api.all('base_id', 'table_name', view='MyView', fields=['ColA', '-ColB'])
+        >>> table = api.table('base_id', 'table_name')
+        >>> table.all(view='MyView', fields=['ColA', '-ColB'])
         [{'fields': ...}, ...]
-        >>> api.all('base_id', 'table_name', max_records=50)
+        >>> table.all(max_records=50)
         [{'fields': ...}, ...]
 
         Keyword Args:
@@ -238,7 +239,8 @@ def create(
         Creates a new record
 
         >>> record = {'Name': 'John'}
-        >>> api.create('base_id', 'table_name', record)
+        >>> table = api.table('base_id', 'table_name')
+        >>> table.create(record)
 
         Args:
             fields: Fields to insert. Must be a dict with field names or IDs as keys.