From 46ff59937354fd92c2b54f29581a42ea0fa96090 Mon Sep 17 00:00:00 2001 From: Tim Gates Date: Thu, 23 Dec 2021 10:40:10 +1100 Subject: [PATCH] docs: Fix a few typos There are small typos in: - docs/source/getting-started.rst - pychievements/signals.py Fixes: - Should read `receive` rather than `recieve`. - Should read `achievement` rather than `achievment`. - Should read `everything` rather than `everyting`. --- docs/source/getting-started.rst | 10 +++++----- pychievements/signals.py | 4 ++-- 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/source/getting-started.rst b/docs/source/getting-started.rst index bd4cfc2..1ad5ce7 100644 --- a/docs/source/getting-started.rst +++ b/docs/source/getting-started.rst @@ -30,7 +30,7 @@ Pychievements has a number of modules that you'll need to be at least familiar w track all registered achievements for specific *tracked_ids*. Achievement - Base Achievment class. + Base Achievement class. icons.Icon Base Icon class. Icons are used to know what to display for a given goal within an @@ -38,12 +38,12 @@ Pychievements has a number of modules that you'll need to be at least familiar w backends.AchievementBackend Pychievements have pluggable backends for storing tracked achievement data. The default - ``AchievementBackend`` simply keeps everyting in memory, meaning it will be lost when the + ``AchievementBackend`` simply keeps everything in memory, meaning it will be lost when the application is closed. The backend the tracker is using can be updated with the ``set_backend`` method. signals - You can register functions as callbacks that can *recieve* Pychievement signals. Signals can + You can register functions as callbacks that can *receive* Pychievement signals. Signals can be generated when a level is changed, when a new goal is reached, or when all goals have been achieved for a given achievement. @@ -73,7 +73,7 @@ An example Achievement class: :: ) An achievements current level for an id can tracked with either the ``increment`` or ``evaluate`` -functions, which the achievment can override to provide custom level manipulation. +functions, which the achievement can override to provide custom level manipulation. The Tracker @@ -96,7 +96,7 @@ The tracker works with the configured backend to store and retrieve all of the t Icons ^^^^^ -Icons are simple classes that provide the "icon" (or what is displayed) for an achievment goal. It +Icons are simple classes that provide the "icon" (or what is displayed) for an achievement goal. It must define what to display for when the goal has been achieved (``achieved``) or not (``unachieved``) diff --git a/pychievements/signals.py b/pychievements/signals.py index 1bbd77e..0c11e58 100644 --- a/pychievements/signals.py +++ b/pychievements/signals.py @@ -30,10 +30,10 @@ def connect(self, receiver, sender=None, dispatch_uid=None): Arguments: receiver - A function or an instance method which is to recieve signals. + A function or an instance method which is to receive signals. sender - The sender to which the receiver should respond. Must be None to recieve events + The sender to which the receiver should respond. Must be None to receive events from any sender. dispatch_uid