CONTRIBUTING.rst

@@ -16,7 +16,7 @@ TL;DR
     $ # Export libpq env vars for PG connection
     $ export PGDATABASE=procrastinate PGHOST=localhost PGUSER=postgres
 
-    $ # Launch Postgres within Docker
+    $ # Launch PostgreSQL within Docker
     $ compose up -d
 
     $ # Explore tox entrypoints
@@ -42,7 +42,7 @@ Environment variables
 
 The `export` command below will be necessary whenever you want to interact with
 the database (using the project locally, launching tests, ...).
-These are standard libpq environment variables, and the values used below correspond
+These are standard ``libpq`` environment variables, and the values used below correspond
 to the docker setup. Feel free to adjust them as necessary.
 
 .. code-block:: console
@@ -53,16 +53,16 @@ Create your development database
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 The development database can be launched using docker with a single command.
-The postgreSQL database we used is a fresh standard out-of-the-box database
+The PostgreSQL database we used is a fresh standard out-of-the-box database
 on the latest stable version.
 
 .. code-block:: console
 
     $ docker-compose up -d
 
-If you want to try out the project locally, it's useful to have postgresql-client
-installed. It will give you both a postgres console (``psql``) and specialized
-commands like `createdb` we use below.
+If you want to try out the project locally, it's useful to have ``postgresql-client``
+installed. It will give you both a PostgreSQL console (``psql``) and specialized
+commands like ``createdb`` we use below.
 
 .. code-block:: console
 
@@ -81,8 +81,8 @@ for your user:
     $ pip install --user tox
 
 In order for this to work, you'll need to make sure your python user install binary
-directory is included in your shell's `PATH`. One way of doing that is to add
-a line in your `~/.profile` (or `~/.zprofile` for zsh). The following command
+directory is included in your shell's ``PATH``. One way of doing that is to add
+a line in your ``~/.profile`` (or ``~/.zprofile`` for ``zsh``). The following command
 will output the line to write in that file:
 
 .. code-block:: console
@@ -172,8 +172,8 @@ hook which makes sure that all your commits are created clean:
     EOF
     chmod +x .git/hooks/pre-commit
 
-If tox is installed inside your virtualenv, you may want to activate the virtualenv
-in ``.git/hooks/pre-commit``:
+If ``tox`` is installed inside your ``virtualenv``, you may want to activate the
+``virtualenv`` in ``.git/hooks/pre-commit``:
 
 .. code-block:: bash
 

docs/discussions.rst

@@ -208,10 +208,10 @@ and an asynchronous code:
   we decided to do.
 
 We've even cheated a bit: instead of implementing our synchronous wrappers manually,
-we've been using a trick that autogenerates a synchronous API based on our asynchronous
-API. This way, we have less code to unit-test, and we can guarantee that the 2 APIs
-will stay synchronized in the future no matter what. Want to know more about this?
-Here are a few resources:
+we've been using a trick that automatically generates a synchronous API based on our
+asynchronous API. This way, we have less code to unit-test, and we can guarantee that
+the 2 APIs will stay synchronized in the future no matter what. Want to know more about
+this? Here are a few resources:
 
 - How we generate our sync API:
   https://github.com/peopledoc/procrastinate/blob/master/procrastinate/utils.py

docs/spelling_wordlist.txt

@@ -1,16 +1,19 @@
+admin
+app
 async
 asynchronicity
 backend
 backoff
+builtin
 codebase
 codebases
 cron
 crons
 Dramatiq
 enqueued
 formatters
+linting
 middleware
-Postgres
 quickstart
 reimplement
 sync

procrastinate/aiopg_connector.py

@@ -67,7 +67,7 @@ def interrupt_wait(connection: aiopg.Connection):
 class PostgresJobStore(store.BaseJobStore):
     """
     Uses ``aiopg`` to establish an asynchronous
-    connection to a Postgres database.
+    connection to a PostgreSQL database.
     """
 
     def __init__(self, *, socket_timeout: float = store.SOCKET_TIMEOUT, **kwargs: Any):

procrastinate/testing.py

@@ -23,7 +23,7 @@ def __init__(self):
         """
         Attributes
         ----------
-        jobs : Dict[int, Dict]
+        jobs : ``Dict[int, Dict]``
             Mapping of ``{<job id>: <Job database row as a dictionary>}``
         """
         self.reset()

tox.ini

@@ -54,4 +54,7 @@ commands =
     sphinx-build -EW -b spelling docs docs/_build/html {posargs}
     doc8 docs
     # wordlist should be sorted to avoid duplicates
-    sort -c docs/spelling_wordlist.txt
+    # If this line breaks, fix with:
+    # sort -bdfi docs/spelling_wordlist.txt -o docs/spelling_wordlist.txt
+    sort -cbdfi docs/spelling_wordlist.txt
+