Apply sphinxcontrib-spelling to the docs for spell checking

Project URL: https://github.com/sphinx-contrib/spelling

sphinxcontrib-spelling is a mature Sphinx extension to do spell checking
across docs. It is used by other big name projects such as Django. This
tool will now run as part of CI.

All spelling mistakes caught by the tool have been fixed. The language
is set to en_US so the British spelling of behaviour was converted to
the American spelling.

The credits.rst file is excluded from checking as it is mostly a list of
people's names which often don't appear in the dictionary.

Author: jdufresne

.travis.yml

@@ -18,6 +18,8 @@ matrix:
     # Documentation
     - python: "3.8"
       env: TOXENV=docs
+      before_install:
+        - sudo apt-get -y install libenchant1c2a
     - python: "3.8"
       env: TOXENV=linkcheck
 

Makefile

@@ -97,6 +97,9 @@ doc:
 linkcheck:
 	$(MAKE) -C $(DOC_DIR) linkcheck
 
+spelling:
+	$(MAKE) -C $(DOC_DIR) SPHINXOPTS=-W spelling
+
 # DOC: Show this help message
 help:
 	@grep -A1 '^# DOC:' Makefile \

README.rst

@@ -61,7 +61,7 @@ while only declaring the test-specific fields:
             )
             # etc.
 
-factory_boy is designed to work well with various ORMs (Django, Mongo, SQLAlchemy),
+factory_boy is designed to work well with various ORMs (Django, MongoDB, SQLAlchemy),
 and can easily be extended for other libraries.
 
 Its main features include:
@@ -325,7 +325,7 @@ Support Policy
 - **Django**'s `supported
   versions <https://www.djangoproject.com/download/#supported-versions>`__.
 - **SQLAlchemy**: `latest version on PyPI <https://pypi.org/project/SQLAlchemy/>`__.
-- **mongoengine**: `latest version on PyPI <https://pypi.org/project/mongoengine/>`__.
+- **MongoEngine**: `latest version on PyPI <https://pypi.org/project/mongoengine/>`__.
 
 Debugging factory_boy
 ---------------------
@@ -407,7 +407,7 @@ Valid options are:
 * ``ALCHEMY`` for ``SQLAlchemy``
 
 
-To avoid running ``mongoengine`` tests (e.g no mongo server installed), run:
+To avoid running ``mongoengine`` tests (e.g no MongoDB server installed), run:
 
 .. code-block:: sh
 

docs/changelog.rst

@@ -25,7 +25,7 @@ ChangeLog
 3.0.1 (2020-08-13)
 ------------------
 
-*Bugfix:*
+*Bug fix:*
 
     - :issue:`769`: Fix ``import factory; factory.django.DjangoModelFactory`` and similar calls.
 
@@ -76,10 +76,10 @@ The following aliases were removed:
 
     - :issue:`561`: Display a developer-friendly error message when providing a model instead of a factory in a :class:`~factory.declarations.SubFactory` class.
 
-*Bugfix:*
+*Bug fix:*
 
-    - Fix issue with SubFactory not preserving signal muting behaviour of the used factory, thanks `Patrick Stein <https://github.com/PFStein>`_.
-    - Fix issue with overriding params in a Trait, thanks `Grégoire Rocher <https://github.com/cecedille1>`_.
+    - Fix issue with SubFactory not preserving signal muting behavior of the used factory, thanks `Patrick Stein <https://github.com/PFStein>`_.
+    - Fix issue with overriding parameters in a Trait, thanks `Grégoire Rocher <https://github.com/cecedille1>`_.
     - :issue:`598`: Limit ``get_or_create`` behavior to fields specified in ``django_get_or_create``.
     - :issue:`606`: Re-raise :class:`~django.db.IntegrityError` when ``django_get_or_create`` with multiple fields fails to lookup model using user provided keyword arguments.
     - :issue:`630`: TypeError masked by __repr__ AttributeError when initializing ``Maybe`` with inconsistent phases.
@@ -98,7 +98,7 @@ The following aliases were removed:
     - Add :class:`~factory.RelatedFactoryList` class for one-to-many support, thanks `Sean Harrington <https://github.com/seanharr11>`_.
     - Make the `locale` argument for :class:`~factory.faker.Faker` keyword-only
 
-*Bugfix:*
+*Bug fix:*
 
     - Allow renamed arguments to be optional, thanks to `Justin Crown <https://github.com/mrname>`_.
     - Fix `django_get_or_create` behavior when using multiple fields with `unique=True`, thanks to `@YPCrumble <https://github.com/YPCrumble>`
@@ -107,15 +107,15 @@ The following aliases were removed:
 2.11.1 (2018-05-05)
 -------------------
 
-*Bugfix:*
+*Bug fix:*
 
     - Fix passing deep context to a :class:`~factory.SubFactory` (``Foo(x__y__z=factory.Faker('name')``)
 
 
 2.11.0 (2018-05-05)
 -------------------
 
-*Bugfix:*
+*Bug fix:*
 
     - Fix :class:`~factory.fuzzy.FuzzyFloat` to return a 15 decimal digits precision float by default
     - :issue:`451`: Restore :class:`~factory.django.FileField` to a
@@ -127,7 +127,7 @@ The following aliases were removed:
 2.10.0 (2018-01-28)
 -------------------
 
-*Bugfix:*
+*Bug fix:*
 
     - :issue:`443`: Don't crash when calling :meth:`factory.Iterator.reset()` on a brand new iterator.
 
@@ -141,7 +141,7 @@ The following aliases were removed:
 2.9.2 (2017-08-03)
 ------------------
 
-*Bugfix:*
+*Bug fix:*
 
     - Fix declaration corruption bug when a factory defined `foo__bar__baz=1` and a caller
       provided a `foo__bar=x` parameter at call time: this got merged into the factory's base
@@ -152,7 +152,7 @@ The following aliases were removed:
 2.9.1 (2017-08-02)
 ------------------
 
-*Bugfix:*
+*Bug fix:*
 
     - Fix packaging issues (see https://github.com/zestsoftware/zest.releaser/issues/212)
     - Don't crash when debugging PostGenerationDeclaration
@@ -163,7 +163,7 @@ The following aliases were removed:
 ------------------
 
 This version brings massive changes to the core engine, thus reducing the number of
-corner cases and weird behaviours.
+corner cases and weird behaviors.
 
 *New:*
 
@@ -184,7 +184,7 @@ corner cases and weird behaviours.
 2.8.1 (2016-12-17)
 ------------------
 
-*Bugfix:*
+*Bug fix:*
 
     - Fix packaging issues.
 
@@ -200,7 +200,7 @@ corner cases and weird behaviours.
       thanks to `Oleg Pidsadnyi <https://github.com/olegpidsadnyi>`_.
     - :issue:`309`: Provide new options for SQLAlchemy session persistence
 
-*Bugfix:*
+*Bug fix:*
 
     - :issue:`334`: Adjust for the package change in ``faker``
 
@@ -251,7 +251,7 @@ corner cases and weird behaviours.
     - Simplify imports for ORM layers, now available through a simple ``factory`` import,
       at ``factory.alchemy.SQLAlchemyModelFactory`` / ``factory.django.DjangoModelFactory`` / ``factory.mongoengine.MongoEngineFactory``.
 
-*Bugfix:*
+*Bug fix:*
 
     - :issue:`201`: Properly handle custom Django managers when dealing with abstract Django models.
     - :issue:`212`: Fix :meth:`factory.django.mute_signals` to handle Django's signal caching
@@ -263,7 +263,7 @@ corner cases and weird behaviours.
 2.5.2 (2015-04-21)
 ------------------
 
-*Bugfix:*
+*Bug fix:*
 
     - Add support for Django 1.7/1.8
     - Add support for mongoengine>=0.9.0 / pymongo>=2.1
@@ -273,7 +273,7 @@ corner cases and weird behaviours.
 2.5.1 (2015-03-27)
 ------------------
 
-*Bugfix:*
+*Bug fix:*
 
     - Respect custom managers in :class:`~factory.django.DjangoModelFactory` (see :issue:`192`)
     - Allow passing declarations (e.g :class:`~factory.Sequence`) as parameters to :class:`~factory.django.FileField`
@@ -291,7 +291,7 @@ corner cases and weird behaviours.
     - Support non-default databases at the factory level (see :issue:`171`)
     - Make :class:`factory.django.FileField` and :class:`factory.django.ImageField` non-post_generation, i.e normal fields also available in ``save()`` (see :issue:`141`).
 
-*Bugfix:*
+*Bug fix:*
 
     - Avoid issues when using :meth:`factory.django.mute_signals` on a base factory class (see :issue:`183`).
     - Fix limitations of :class:`factory.StubFactory`, that can now use :class:`factory.SubFactory` and co (see :issue:`131`).
@@ -342,7 +342,7 @@ This takes care of all ``FACTORY_FOR`` occurrences; the files containing other a
 2.4.1 (2014-06-23)
 ------------------
 
-*Bugfix:*
+*Bug fix:*
 
     - Fix overriding deeply inherited attributes (set in one factory, overridden in a subclass, used in a sub-sub-class).
 
@@ -384,10 +384,10 @@ This takes care of all ``FACTORY_FOR`` occurrences; the files containing other a
 2.3.1 (2014-01-22)
 ------------------
 
-*Bugfix:*
+*Bug fix:*
 
     - Fix badly written assert containing state-changing code, spotted by `chsigi <https://github.com/chsigi>`_ (:pr:`126`)
-    - Don't crash when handling objects whose __repr__ is non-pure-ascii bytes on Py2,
+    - Don't crash when handling objects whose ``__repr__`` is non-pure-ASCII bytes on Python 2,
       discovered by `mbertheau <https://github.com/mbertheau>`_ (:issue:`123`) and `strycore <https://github.com/strycore>`_ (:pr:`127`)
 
 .. _v2.3.0:
@@ -406,7 +406,7 @@ This takes care of all ``FACTORY_FOR`` occurrences; the files containing other a
 2.2.1 (2013-09-24)
 ------------------
 
-*Bugfix:*
+*Bug fix:*
 
     - Fixed sequence counter for :class:`~factory.django.DjangoModelFactory` when a factory
       inherits from another factory relating to an abstract model.
@@ -416,13 +416,13 @@ This takes care of all ``FACTORY_FOR`` occurrences; the files containing other a
 2.2.0 (2013-09-24)
 ------------------
 
-*Bugfix:*
+*Bug fix:*
 
     - Removed duplicated :class:`~factory.alchemy.SQLAlchemyModelFactory` lurking in :mod:`factory`
       (:pr:`83`)
     - Properly handle sequences within object inheritance chains.
-      If FactoryA inherits from FactoryB, and their associated classes share the same link,
-      sequence counters will be shared (:issue:`93`)
+      If ``FactoryA`` inherits from ``FactoryB``, and their associated classes
+      share the same link, sequence counters will be shared (:issue:`93`)
     - Properly handle nested :class:`~factory.SubFactory` overrides
 
 *New:*
@@ -449,7 +449,7 @@ This takes care of all ``FACTORY_FOR`` occurrences; the files containing other a
 2.1.1 (2013-07-02)
 ------------------
 
-*Bugfix:*
+*Bug fix:*
 
     - Properly retrieve the ``color`` keyword argument passed to :class:`~factory.django.ImageField`
 
@@ -476,9 +476,9 @@ This takes care of all ``FACTORY_FOR`` occurrences; the files containing other a
     - Add :class:`factory.django.FileField` and :class:`factory.django.ImageField` hooks for
       related Django model fields (:issue:`52`)
 
-*Bugfix*
+*Bug fix*
 
-    - Properly handle non-integer pks in :class:`~factory.django.DjangoModelFactory` (:issue:`57`).
+    - Properly handle non-integer primary keys in :class:`~factory.django.DjangoModelFactory` (:issue:`57`).
     - Disable :class:`~factory.RelatedFactory` generation when a specific value was
       passed (:issue:`62`, thanks to `Gabe Koscky <https://github.com/dhekke>`_)
 
@@ -603,7 +603,7 @@ All warnings will turn into errors starting from v2.0.0.
 In order to upgrade client code, apply the following rules:
 
 - Add a ``FACTORY_FOR`` attribute pointing to the target class to each
-  :class:`~factory.Factory`, instead of relying on automagic associated class
+  :class:`~factory.Factory`, instead of relying on automatic associated class
   discovery
 - When using factory_boy for Django models, have each factory inherit from
   :class:`~factory.django.DjangoModelFactory`
@@ -633,7 +633,7 @@ In order to upgrade client code, apply the following rules:
 1.1.5 (2012-07-09)
 ------------------
 
-*Bugfix:*
+*Bug fix:*
 
     - Fix :class:`~factory.PostGenerationDeclaration` and derived classes.
 
@@ -657,7 +657,7 @@ In order to upgrade client code, apply the following rules:
 1.1.3 (2012-03-09)
 ------------------
 
-*Bugfix:*
+*Bug fix:*
 
   - Fix packaging rules
 
@@ -696,9 +696,9 @@ In order to upgrade client code, apply the following rules:
   - Provide the :func:`~factory.make_factory` helper: ``MyClassFactory = make_factory(MyClass, x=3, y=4)``
   - Add :func:`~factory.build`, :func:`~factory.create`, :func:`~factory.stub` helpers
 
-*Bugfix:*
+*Bug fix:*
 
-  - Allow classmethod/staticmethod on factories
+  - Allow ``classmethod``/``staticmethod`` on factories
 
 *Deprecation:*
 
@@ -721,11 +721,11 @@ In order to upgrade client code, apply the following rules:
   - Provide :class:`~factory.django.DjangoModelFactory`, whose :class:`~factory.Sequence` counter starts at the next free database id
   - Introduce :class:`~factory.SelfAttribute`, a shortcut for ``factory.LazyAttribute(lambda o: o.foo.bar.baz``.
 
-*Bugfix:*
+*Bug fix:*
 
   - Handle nested :class:`~factory.SubFactory`
   - Share sequence counter between parent and subclasses
-  - Fix :class:`~factory.SubFactory` / :class:`~factory.Sequence` interferences
+  - Fix :class:`~factory.SubFactory` / :class:`~factory.Sequence` interference
 
 
 .. _v1.0.2:
@@ -748,7 +748,7 @@ In order to upgrade client code, apply the following rules:
   - Allow :class:`~factory.Factory` inheritance
   - Improve handling of custom build/create functions
 
-*Bugfix:*
+*Bug fix:*
 
   - Fix concurrency between :class:`~factory.LazyAttribute` and :class:`~factory.Sequence`
 
@@ -766,8 +766,6 @@ In order to upgrade client code, apply the following rules:
 Credits
 -------
 
-* Initial version by Mark Sandstrom (2010)
-* Developed by Raphaël Barrois since 2011
-
+See :doc:`credits`.
 
 .. vim:et:ts=4:sw=4:tw=119:ft=rst:

docs/conf.py

@@ -85,3 +85,9 @@
         'https://docs.sqlalchemy.org/en/latest/objects.inv',
     ),
 }
+
+
+# -- spelling ---------------------------------------------------------------
+spelling_exclude_patterns = [
+    'credits.rst',
+]

docs/internals.rst

@@ -46,20 +46,20 @@ Parsing, Step 2: adapting the class definition
           for declaration ``foo``.
 
 
-Instantiating, Step 1: Converging entrypoints
----------------------------------------------
+Instantiating, Step 1: Converging entry points
+----------------------------------------------
 
 First, decide the strategy:
 
-- If the entrypoint is specific to a strategy (:meth:`~Factory.build`,
+- If the entry point is specific to a strategy (:meth:`~Factory.build`,
   :meth:`~Factory.create_batch`, ...), use it
 - If it is generic (:meth:`~Factory.generate`, :meth:`Factory.__call__`),
   use the strategy defined at the :attr:`class Meta <Factory.Meta>` level
 
 
 Then, we'll pass the strategy and passed-in overrides to the :meth:`~Factory._generate` method.
 
-.. note:: According to the project roadmap, a future version will use a :meth:`~Factory._generate_batch`` at its core instead.
+.. note:: According to the project road map, a future version will use a :meth:`~Factory._generate_batch`` at its core instead.
 
 A factory's :meth:`~Factory._generate` function actually delegates to a ``StepBuilder()`` object.
 This object will carry the overall "build an object" context (strategy, depth, and possibly other).

docs/introduction.rst

@@ -266,8 +266,8 @@ This is handled by the :data:`~factory.FactoryOptions.inline_args` attribute:
     <MyClass(1, 4, z=3)>
 
 
-Altering a factory's behaviour: parameters and traits
------------------------------------------------------
+Altering a factory's behavior: parameters and traits
+----------------------------------------------------
 
 Some classes are better described with a few, simple parameters, that aren't fields on the actual model.
 In that case, use a :attr:`~factory.Factory.Params` declaration:

docs/orms.rst

@@ -334,7 +334,7 @@ To work, this class needs an `SQLAlchemy`_ session object affected to the :attr:
 
     .. attribute:: sqlalchemy_session_persistence
 
-        Control the action taken by sqlalchemy session at the end of a create call.
+        Control the action taken by ``sqlalchemy_session`` at the end of a create call.
 
         Valid values are: