Merge pull request #449 from mesozoic/fix_docs

Fixing documentation typos

Author: mesozoic

docs/source/_substitutions.rst

@@ -58,7 +58,7 @@
 
 .. |kwarg_replace| replace:: If ``True``, record is replaced in its entirety
     by provided fields; if a field is not included its value will
-    bet set to null. If ``False``, only provided fields are updated.
+    be set to null. If ``False``, only provided fields are updated.
 
 .. |kwarg_use_field_ids| replace:: An optional boolean value that lets you return field objects where the
     key is the field id. This defaults to ``False``, which returns field objects where the key is the field name.

docs/source/about.rst

@@ -4,7 +4,7 @@ About
 
 Questions
 *********
-Post them over in the project's `Github Page <http://www.github.com/gtalarico/pyairtable>`_
+Post them over in the project's `Github Page <https://github.com/gtalarico/pyairtable>`_
 
 _______________________________________________
 
@@ -18,7 +18,7 @@ Contribute
    # Create Virtual Environment
    python3 -m venv .venv
    source .venv/bin/activate
-   make setup # Sets up githooks and install package and depedencies
+   make setup # Sets up githooks and install package and dependencies
    make test # run test complete suite
    # Optional, use as needed
    make lint # lints locally - also done in pre-merge CI

docs/source/changelog.rst

@@ -233,7 +233,7 @@ See :ref:`Migrating from 1.x to 2.0` for detailed migration notes.
   - `PR #277 <https://github.com/gtalarico/pyairtable/pull/277>`_
 * Added :meth:`Model.batch_save <pyairtable.orm.Model.batch_save>`
   and :meth:`Model.batch_delete <pyairtable.orm.Model.batch_delete>`.
-  - `PR #274 <https://github.com/gtalarico/pyairtable/pull/277>`_
+  - `PR #274 <https://github.com/gtalarico/pyairtable/pull/274>`_
 * Added :meth:`Api.whoami <pyairtable.Api.whoami>` method.
   - `PR #273 <https://github.com/gtalarico/pyairtable/pull/273>`_
 * pyAirtable will automatically retry requests when throttled by Airtable's QPS.

docs/source/orm.rst

@@ -585,10 +585,10 @@ configured to memoize by default, pass ``memoize=False`` to override it.
      - Never
    * - :meth:`Model.from_id <pyairtable.orm.Model.from_id>`
      - Yes
-     - Yes, unless ``fetch=True``
+     - Yes, unless ``fetch=False``
    * - :meth:`Model.from_ids <pyairtable.orm.Model.from_ids>`
      - Yes
-     - Yes, unless ``fetch=True``
+     - Yes, unless ``fetch=False``
    * - :meth:`LinkField.populate <pyairtable.orm.fields.LinkField.populate>`
      - Yes
      - Yes, unless ``lazy=True``

docs/source/tables.rst

@@ -126,21 +126,21 @@ This library will return records as :class:`~pyairtable.api.types.RecordDict`.
   [
       {
           'id': 'recwPQIfs4wKPyc9D',
-          'createdTime': '2017-03-14T22:04:31.000Z'
+          'createdTime': '2017-03-14T22:04:31.000Z',
           'fields': {
               'Name': 'Alice',
           },
       },
       {
           'id': 'rechOLltN9SpPHq5o',
-          'createdTime': '2017-03-20T15:21:50.000Z'
+          'createdTime': '2017-03-20T15:21:50.000Z',
           'fields': {
               'Name': 'Bob',
           },
       },
       {
           'id': 'rec5eR7IzKSAOBHCz',
-          'createdTime': '2017-08-05T21:47:52.000Z'
+          'createdTime': '2017-08-05T21:47:52.000Z',
           'fields': {
               'Name': 'Carol',
           },

pyairtable/models/_base.py

@@ -317,12 +317,12 @@ def rebuild_models(
 
     Only intended for use within pyAirtable, like:
 
-        >>> from pyairtable.models._base import AirtableModel, update_forward_refs
+        >>> from pyairtable.models._base import AirtableModel, rebuild_models
         >>> class A(AirtableModel): ...
         >>> class B(AirtableModel): ...
         ...     class B_One(AirtableModel): ...
         ...     class B_Two(AirtableModel): ...
-        >>> update_forward_refs(vars())
+        >>> rebuild_models(vars())
     """
     memo = set() if memo is None else memo
     # If it's a type, update its refs, then do the same for any nested classes.

tests/test_models.py

@@ -233,9 +233,9 @@ def test_writable_and_readonly(create_instance):
         create_instance(writable=["foo"], readonly=["bar"])
 
 
-def test_update_forward_refs():
+def test_rebuild_models():
     """
-    Test that update_forward_refs does not get caught in an infinite loop.
+    Test that rebuild_models does not get caught in an infinite loop.
     """
 
     class Outer(AirtableModel):