Spelling + add spellcheck to CI

.travis.yml

@@ -43,6 +43,11 @@ matrix:
     os: linux
     dist: xenial
     stage: lint
+  - python: 3.7.2
+    env: TOXENV=spell
+    os: linux
+    dist: xenial
+    stage: lint
   - python: 3.6.0
     env: TOXENV=3.6 IDENT="3.6.0" RUN_SUITE=y NO_CYTHON=y
     os: linux

AUTHORS.rst

@@ -15,8 +15,8 @@ Creators
     Ask the community for help in the Slack channel, or ask
     a question on Stack Overflow.
 
-Comitters
-=========
+Committers
+==========
 
 +---------------------+---------------------------------------+
 | Arpan Shah          | <arpan@robinhood.com>                 |

CONTRIBUTING.rst

@@ -28,7 +28,7 @@ the person merging the changes so don't worry too much.
 Code of Conduct
 ===============
 
-Everyone interacting in the project's codebases, issue trackers, chat rooms,
+Everyone interacting in the project's code bases, issue trackers, chat rooms,
 and mailing lists is expected to follow the Faust Code of Conduct.
 
 As contributors and maintainers of these projects, and in the interest of fostering

Changelog.rst

@@ -46,7 +46,7 @@ please visit the :ref:`history` section.
 
     Implemented in the default monitor, but also for statsd and datadog.
 
-- **CLI**: The :program:`faust` program had the wrong help descrioption.
+- **CLI**: The :program:`faust` program had the wrong help description.
 
 - **Docs**: Fixes typo in :setting:`web_cors_options` example.
 
@@ -237,7 +237,7 @@ please visit the :ref:`history` section.
 - **App**: Web server is no longer running in a separate thread by default.
 
     Running the web server in a separate thread is beneficial as it
-    will not be affected by backpressue in the main thread event loop,
+    will not be affected by back pressure in the main thread event loop,
     but it also makes programming harder when it cannot share the loop
     of the parent.
 
@@ -332,7 +332,7 @@ please visit the :ref:`history` section.
 
     See new :setting:`web_cors_options` setting.
 
-- **Debugging**: Added `OpenTracing`_ hooks to streams/tasks/timers/crontabs
+- **Debugging**: Added `OpenTracing`_ hooks to streams/tasks/timers/Crontabs
    and rebalancing process.
 
     To enable you have to define a custom ``Tracer`` class that will

Makefile

@@ -60,7 +60,7 @@ help:
 	@echo "contrib              - Regenerate CONTRIBUTING.rst file"
 	@echo "coc                  - Regenerate CODE_OF_CONDUCT.rst file"
 	@echo "clean-dist --------- - Clean all distribution build artifacts."
-	@echo "  clean-git-force    - Remove all uncomitted files."
+	@echo "  clean-git-force    - Remove all uncommitted files."
 	@echo "  clean ------------ - Non-destructive clean"
 	@echo "    clean-pyc        - Remove .pyc/__pycache__ files"
 	@echo "    clean-docs       - Remove documentation build artifacts."
@@ -113,6 +113,9 @@ apicheck:
 configcheck:
 	(cd "$(SPHINX_DIR)"; $(MAKE) configcheck)
 
+spell:
+	(cd "$(SPHINX_DIR)"; $(MAKE) spell)
+
 flakecheck:
 	$(FLAKE8) "$(PROJ)" "$(TESTDIR)" examples/
 

README.rst

@@ -580,7 +580,7 @@ documentation.
 Code of Conduct
 ===============
 
-Everyone interacting in the project's codebases, issue trackers, chat rooms,
+Everyone interacting in the project's code bases, issue trackers, chat rooms,
 and mailing lists is expected to follow the Faust Code of Conduct.
 
 As contributors and maintainers of these projects, and in the interest of fostering

TODO.rst

@@ -129,7 +129,7 @@ Documentation
 
     - Message lifecycle
 
-    - Manual acknowledgement (``async with event``)
+    - Manual acknowledgment (``async with event``)
 
     - Arguments to ``app.agent``
 
@@ -168,7 +168,7 @@ Documentation
 
     - recovery
 
-    - acknowledgements
+    - acknowledgments
 
 - Go through comments in the code, some of it describes things that should
   be documented.

docs/Makefile

@@ -52,7 +52,7 @@ help:
 	@echo "  coverage    to run coverage check of the documentation (if enabled)"
 	@echo "  apicheck    to verify that all modules are present in autodoc"
 	@echo "  configcheck to verify that all modules are present in autodoc"
-	@echo "  spelling    to run a spell checker on the documentation"
+	@echo "  spell       to run a spell checker on the documentation"
 
 .PHONY: clean
 clean:
@@ -233,9 +233,9 @@ apicheck:
 configcheck:
 	$(SPHINXBUILD) -b configcheck $(ALLSPHINXOPTS) $(BUILDDIR)/configcheck
 
-.PHONY: spelling
-spelling:
-	SPELLCHECK=1 $(SPHINXBUILD) -b spelling $(ALLSPHINXOPTS) $(BUILDDIR)/spelling
+.PHONY: spell
+spell:
+	SPELLCHECK=1 $(SPHINXBUILD) -b spelling $(ALLSPHINXOPTS) $(BUILDDIR)/spell
 
 .PHONY: xml
 xml:

docs/developerguide/overview.rst

@@ -48,7 +48,7 @@ Module Overview
     top-level package.
 
 ``faust.web``
-    Web abstractions and web apps served by the Faust web server.
+    Web abstractions and web applications served by the Faust web server.
 
 ``faust.windows``
     Windowing strategies.
@@ -63,8 +63,8 @@ Services
 Everything in Faust that can be started/stopped and restarted, is a
 :class:`~faust.utils.services.Service`.
 
-Services can start other services, but they can also start asyncio.Tasks via
-`self.add_future`.  These dependencies will be started/stopped/restarted with
+Services can start other services, but they can also start :class:`asyncio.Task`
+via `self.add_future`.  These dependencies will be started/stopped/restarted with
 the service.
 
 ``Worker``
@@ -76,7 +76,7 @@ setting up logging, installs signal handlers and debugging tools etc.
 ``App``
 -------
 
-The app configures the Faust instance, and is the entrypoint for just about
+The app configures the Faust instance, and is the entry point for just about
 everything that happens in a Faust instance.  Consuming/Producing messages,
 starting streams and agents, etc.
 
@@ -102,7 +102,7 @@ in anticipation of messages to be produced.
 
 The Consumer is responsible for consuming messages from Kafka topics, to be
 delivered to the streams.  It does not actually fetch messages (the
-``Fetcher`` services does tha), but it handles everything to do with
+``Fetcher`` services does that), but it handles everything to do with
 consumption, like managing topic subscriptions etc.
 
 ``Agent``

docs/glossary.rst

@@ -9,7 +9,7 @@ Glossary
     acked
     acking
     acknowledged
-        Acknowledgement marks a message as fully processed.
+        Acknowledgment marks a message as fully processed.
         It’s a signal that the program does not want to see the message again.
         Faust advances the offset by committing after a message is acknowledged.
 
@@ -95,7 +95,7 @@ Glossary
         Further reading: https://en.wikipedia.org/wiki/Idempotent
 
     nullipotent
-    nillipotence
+    nullipotence
     nullipotency
         describes a function that'll have the same effect, and give the same
         result, even if called zero or multiple times (side-effect free).

docs/history/changelog-1.0.rst

@@ -180,7 +180,7 @@ For even older releases you can visit the :ref:`history` section.
 - **Web**: Adds ``app.on_webserver_init(web)`` callback for ability to serve static
   files using ``web.add_static``.
 
-- **Web**: Adds web.add_static(prefix, fs_path)
+- **Web**: Adds ``web.add_static(prefix, fs_path)``
 
 - **Worker**: New ``App.unassigned`` attribute is now set if the worker
   does not have any assigned partitions.
@@ -267,7 +267,7 @@ For even older releases you can visit the :ref:`history` section.
     with the official versions of :pypi:`aiokafka` and :pypi:`kafka-python`.
 
     If you have those in requirements, please remove them from your
-    virtual env and remove them from requirements.
+    ``virtualenv`` and remove them from requirements.
 
 - **Worker**: Fixes hanging in wait_empty.
 
@@ -303,7 +303,7 @@ For even older releases you can visit the :ref:`history` section.
 
     + Now depends on :pypi:`robinhood-aiokafka` 0.4.12
 
-- **Worker**: Fixed problem where worker does not recover after macbook
+- **Worker**: Fixed problem where worker does not recover after MacBook
   sleeping and waking up.
 
 - **Worker**: Fixed crash that could lead to rebalancing loop.
@@ -377,11 +377,11 @@ For even older releases you can visit the :ref:`history` section.
 - **Statsd**: The statsd monitor prematurely initialized the event loop
   on module import.
 
-    We had a fix for this, but somehow forgot to remove the "hardcoded
+    We had a fix for this, but somehow forgot to remove the "hard coded
     super" that was set to call: ``Service.__init__(self, **kwargs)``.
 
     The class is not even a subclass of Service anymore, and we are lucky it
-    manifests merely when doing something drastic, like py.test,
+    manifests merely when doing something drastic, like ``py.test``,
     recursively importing all modules in a directory.
 
 .. _version-1.0.12:
@@ -523,10 +523,10 @@ For even older releases you can visit the :ref:`history` section.
     + Now depends on Aiokafka 0.4.7.
 
 
-- **Table**: Delete keys whe raw value in changelog set to None
+- **Table**: Delete keys when raw value in changelog set to :const:`None`
 
-    This was resulting in deleted keys still being present with value None
-    upon recovery.
+    This was resulting in deleted keys still being present with value
+    :const:`None` upon recovery.
 
 - **Transports**: Crash app on CommitFailedError thrown by :pypi:`aiokafka`.
 
@@ -562,7 +562,7 @@ For even older releases you can visit the :ref:`history` section.
     with 100% CPU usage.
 
     After processing all records in all topic partitions, the worker
-    would spinloop.
+    would spin loop.
 
 - **API**: Added new base class for windows: :class:`faust.Window`
 
@@ -743,7 +743,7 @@ For even older releases you can visit the :ref:`history` section.
             # manual acknowledgment
             await stream.ack(stream.current_event)
 
-    .. admonition:: Manual Acknowledgement
+    .. admonition:: Manual Acknowledgment
 
         The stream is a sequence of events, where each event has a sequence
         number: the "offset".
@@ -752,7 +752,7 @@ For even older releases you can visit the :ref:`history` section.
         the Kafka broker will keep track of the last committed offset
         for any topic.
 
-        This means "acknowledgement" works quite differently from other
+        This means "acknowledgment" works quite differently from other
         message brokers, such as RabbitMQ where you can selectively
         ack some messages, but not others.
 

docs/history/changelog-1.1.rst

@@ -57,7 +57,7 @@ For even older releases you can visit the :ref:`history` section.
     if the buffer grows too large and we have too much to do
     during commit.
 
-    The commit operation works like this (in pseudocode) when
+    The commit operation works like this (in pseudo code) when
     :setting:`stream_publish_on_commit` is enabled:
 
     .. sourcecode:: python
@@ -262,7 +262,7 @@ News
             volume: Decimal
 
     When serialized this model will use string for decimal fields
-    (the javascript float type cannot be used without losing precision, it
+    (the Javascript float type cannot be used without losing precision, it
     is a float after all), but when deserializing Faust will reconstruct
     them as Decimal objects from that string.
 
@@ -390,7 +390,7 @@ News
     Contributed by Mika Eloranta (:github_user:`melor`).
 
 - **Distribution**: ``pip install faust`` no longer installs the examples
-  direcrtory.
+  directory.
 
     Fix contributed by Michael Seifert (:github_user:`seifertm`)
 

docs/history/changelog-1.2.rst

@@ -65,7 +65,7 @@ For even older releases you can visit the :ref:`history` section.
     This will be the :class:`aiohttp.web_app.Application` instance used.
 
 - **Documentation**: Fixed markup typo in the settings section of the
-  userguide (Issue #177).
+  :ref:`guide` (Issue #177).
 
     Contributed by Denis Kataev (:github_user:`kataev`).
 

docs/history/changelog-1.4.rst

@@ -24,7 +24,7 @@ For even older releases you can visit the :ref:`history` section.
 - :setting:`max_poll_records` accidentally set to 500 by default.
 
     The setting has been reverted to its documented default of :const:`None`.
-    This resulted in a 20x performance improvement :tada:
+    This resulted in a 20x performance improvement.
 
 - **CLI**: Now correctly returns non-zero exitcode when exception raised
   inside ``@app.command``.
@@ -195,7 +195,7 @@ For even older releases you can visit the :ref:`history` section.
 
     + Allison Wang (:github_user:`allisonwang`).
     + Thibault Serot (:github_user:`thibserot`).
-    + oucb (:github_user:`oucb`).
+    + :github_user:`oucb`.
 
 - **CI**: Added CPython 3.7.2 and 3.6.8 to Travis CI build matrix.
 
@@ -252,8 +252,8 @@ For even older releases you can visit the :ref:`history` section.
 
 - **Worker**: The Kafka consumer is now running in a separate thread.
 
-    The Kafka heartbeat background corutine sends heartbeats every 3.0 seconds,
-    and if those are missed rebalancing occurs.
+    The Kafka heartbeat background coroutine sends heartbeats
+    every 3.0 seconds, and if those are missed rebalancing occurs.
 
     This patch moves the :pypi:`aiokafka` library inside a separate thread,
     this way it can send responsive heartbeats and operate even when agents
@@ -273,9 +273,9 @@ For even older releases you can visit the :ref:`history` section.
     Instead we periodically flush changes to RocksDB, and populate the sets
     from disk at worker startup/table recovery.
 
-- **App**: Adds support for crontab tasks.
+- **App**: Adds support for Crontab tasks.
 
-    You can now define periodic tasks using cron-syntax:
+    You can now define periodic tasks using Cron-syntax:
 
     .. sourcecode:: python
 
@@ -293,12 +293,12 @@ For even older releases you can visit the :ref:`history` section.
 - **App**: Providing multiple URLs to the :setting:`broker` setting
   now works as expected.
 
-    To facilitiate this change ``app.conf.broker`` is now
+    To facilitate this change ``app.conf.broker`` is now
     ``List[URL]`` instead of a single :class:`~yarl.URL`.
 
 - **App**: New :setting:`timezone` setting.
 
-    This setting is currently used as the default timezone for crontab tasks.
+    This setting is currently used as the default timezone for Crontab tasks.
 
 - **App**: New :setting:`broker_request_timeout` setting.
 

docs/includes/code-of-conduct.txt

@@ -1,7 +1,7 @@
 Code of Conduct
 ===============
 
-Everyone interacting in the project's codebases, issue trackers, chat rooms,
+Everyone interacting in the project's code bases, issue trackers, chat rooms,
 and mailing lists is expected to follow the Faust Code of Conduct.
 
 As contributors and maintainers of these projects, and in the interest of fostering

docs/includes/installation.txt

@@ -44,7 +44,7 @@ Caching
 ~~~~~~~
 
 :``faust[redis]``:
-    for using `Redis_` as a simple caching backend (memcache-style).
+    for using `Redis_` as a simple caching backend (Memcached-style).
 
 Optimization
 ~~~~~~~~~~~~

docs/includes/intro.txt

@@ -44,7 +44,7 @@ This system can persist state, acting like a database.
 Tables are named distributed key/value stores you can use
 as regular Python dictionaries.
 
-Tables are stored locally on each machine using a superfast
+Tables are stored locally on each machine using a super fast
 embedded database written in C++, called `RocksDB`_.
 
 Tables can also store aggregate counts that are optionally "windowed"

docs/includes/introduction.txt

@@ -58,4 +58,4 @@
     Faust is just Python, and a stream is an infinite asynchronous iterator.
     If you know how to use Python, you already know how to use Faust,
     and it works with your favorite Python libraries like Django, Flask,
-    SQLAlchemy, NTLK, NumPy, Scikit, TensorFlow, etc.
+    SQLAlchemy, NTLK, NumPy, SciPy, TensorFlow, etc.