Implement automatic spell-check for docs (#688)

* [WIP] Implement automatic spell-check for docs

fixes #663

The only thing unclear to me so far is how the output of `make spelling`
should be checked - is there a possibility to check for a file (i.e.
`_build/spelling/output.txt`) to be empty, and report a failed build
otherwise?

* fix typo in requirements.txt

* add enchant library

* travis should report errors, order spelling wordlist

* change travis.yml to easier troubleshoot build issues

* fixed more typos, added more words

* add more words, fix more typos

* added more words

* added more words

* revert changes to .travis.yml

src/pretix/base/exporter.py

@@ -25,7 +25,7 @@ class BaseExporter:
         """
         A short and unique identifier for this exporter.
         This should only contain lowercase letters and in most
-        cases will be the same as your packagename.
+        cases will be the same as your package name.
         """
         raise NotImplementedError()  # NOQA
 

src/pretix/base/models/invoices.py

@@ -55,9 +55,9 @@ class Invoice(models.Model):
     :type footer_text: str
     :param foreign_currency_display: A different currency that taxes should also be displayed in.
     :type foreign_currency_display: str
-    :param foreign_currency_rate: The rate of a forein currency that the taxes should be displayed in.
+    :param foreign_currency_rate: The rate of a foreign currency that the taxes should be displayed in.
     :type foreign_currency_rate: Decimal
-    :param foreign_currency_rate_date: The date of the forein currency exchange rates.
+    :param foreign_currency_rate_date: The date of the foreign currency exchange rates.
     :type foreign_currency_rate_date: date
     :param file: The filename of the rendered invoice
     :type file: File

src/pretix/base/models/items.py

@@ -550,7 +550,7 @@ class Question(LoggedModel):
     :param question: The question text. This will be displayed next to the input field.
     :type question: str
     :param type: One of the above types
-    :param required: Whether answering this question is required for submiting an order including
+    :param required: Whether answering this question is required for submitting an order including
                      items associated with this question.
     :type required: bool
     :param items: A set of ``Items`` objects that this question should be applied to
@@ -667,7 +667,7 @@ class Quota(LoggedModel):
         again if those people do not proceed to the checkout.
 
     AVAILABILITY_ORDERED
-        This item is currently not availalbe for sale because all available
+        This item is currently not available for sale because all available
         items are ordered. It might become available again if those people
         do not pay.
 

src/pretix/base/models/orders.py

@@ -188,7 +188,7 @@ class Order(LoggedModel):
     def full_code(self):
         """
         An order code which is unique among all events of a single organizer,
-        built by contatenating the event slug and the order code.
+        built by concatenating the event slug and the order code.
         """
         return '{event}-{code}'.format(event=self.event.slug.upper(), code=self.code)
 
@@ -519,7 +519,7 @@ class AbstractPosition(models.Model):
     :type variation: ItemVariation
     :param datetime: The datetime this item was put into the cart
     :type datetime: datetime
-    :param expires: The date until this item is guarenteed to be reserved
+    :param expires: The date until this item is guaranteed to be reserved
     :type expires: datetime
     :param price: The price of this item
     :type price: decimal.Decimal

src/pretix/base/payment.py

@@ -324,7 +324,7 @@ class BasePaymentProvider:
         at least store the user's input into his session.
 
         This method should return ``False`` if the user's input was invalid, ``True``
-        if the input was valid and the frontend should continue with default behaviour
+        if the input was valid and the frontend should continue with default behavior
         or a string containing a URL if the user should be redirected somewhere else.
 
         On errors, you should use Django's message framework to display an error message
@@ -375,7 +375,7 @@ class BasePaymentProvider:
         """
         After the user has confirmed their purchase, this method will be called to complete
         the payment process. This is the place to actually move the money if applicable.
-        If you need any special  behaviour,  you can return a string
+        If you need any special  behavior,  you can return a string
         containing the URL the user will be redirected to. If you are done with your process
         you should return the user to the order's detail page.
 
@@ -523,8 +523,8 @@ class BasePaymentProvider:
         Will be called if the event administrator confirms the refund.
 
         This should transfer the money back (if possible). You can return the URL the
-        user should be redirected to if you need special behaviour or None to continue
-        with default behaviour.
+        user should be redirected to if you need special behavior or None to continue
+        with default behavior.
 
         On failure, you should use Django's message framework to display an error message
         to the user.
@@ -588,8 +588,8 @@ class FreeOrderProvider(BasePaymentProvider):
         Will be called if the event administrator confirms the refund.
 
         This should transfer the money back (if possible). You can return the URL the
-        user should be redirected to if you need special behaviour or None to continue
-        with default behaviour.
+        user should be redirected to if you need special behavior or None to continue
+        with default behavior.
 
         On failure, you should use Django's message framework to display an error message
         to the user.

src/pretix/base/signals.py

@@ -315,7 +315,7 @@ This signal allows you to implement a middleware-style filter on all outgoing em
 return a (possibly modified) copy of the message object passed to you.
 
 As with all event-plugin signals, the ``sender`` keyword argument will contain the event.
-The ``message`` argument will contian an ``EmailMultiAlternatives`` object.
+The ``message`` argument will contain an ``EmailMultiAlternatives`` object.
 If the email is associated with a specific order, the ``order`` argument will be passed as well, otherwise
 it will be ``None``.
 """

src/pretix/control/forms/global_settings.py

@@ -43,7 +43,7 @@ class UpdateSettingsForm(SettingsForm):
                     "the current version of pretix and your installed plugins and the number of active and "
                     "inactive events in your installation to servers operated by the pretix developers. We "
                     "will only store anonymous data, never any IP addresses and we will not know who you are "
-                    "or where to find your instance. You can disable this behaviour here at any time.")
+                    "or where to find your instance. You can disable this behavior here at any time.")
     )
     update_check_email = forms.EmailField(
         required=False,

src/pretix/control/signals.py

@@ -176,7 +176,7 @@ as active.
 
 If your linked view should stay in the tab-like context of this page, we recommend
 that you use ``pretix.control.views.organizer.OrganizerDetailViewMixin`` for your view
-and your tempalte inherits from ``pretixcontrol/organizers/base.html``.
+and your template inherits from ``pretixcontrol/organizers/base.html``.
 
 This is a regular django signal (no pretix event signal). Receivers will be passed
 the keyword arguments ``organizer`` and ``request``.
@@ -205,7 +205,7 @@ as active.
 
 If your linked view should stay in the tab-like context of this page, we recommend
 that you use ``pretix.control.views.event.EventSettingsViewMixin`` for your view
-and your tempalte inherits from ``pretixcontrol/event/settings_base.html``.
+and your template inherits from ``pretixcontrol/event/settings_base.html``.
 
 As with all plugin signals, the ``sender`` keyword argument will contain the event.
 A second keyword argument ``request`` will contain the request object.

src/pretix/plugins/paypal/payment.py

@@ -166,8 +166,8 @@ class Paypal(BasePaymentProvider):
         Will be called if the user submitted his order successfully to initiate the
         payment process.
 
-        It should return a custom redirct URL, if you need special behaviour, or None to
-        continue with default behaviour.
+        It should return a custom redirct URL, if you need special behavior, or None to
+        continue with default behavior.
 
         On errors, it should use Django's message framework to display an error message
         to the user (or the normal form validation error messages).

src/pretix/presale/signals.py

@@ -64,7 +64,7 @@ order_meta_from_request = EventPluginSignal(
 """
 This signal is sent before an order is created through the pretixpresale frontend. It allows you
 to return a dictionary that will be merged in the meta_info attribute of the order.
-You will recieve the request triggering the order creation as the ``request`` keyword argument.
+You will receive the request triggering the order creation as the ``request`` keyword argument.
 
 As with all event-plugin signals, the ``sender`` keyword argument will contain the event.
 """