Skip to content

docs: Fix a few typos #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions docs/source/getting-started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -30,20 +30,20 @@ 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
achievement and have two states, achieved and unachieved.

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.

Expand Down Expand Up @@ -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
Expand All @@ -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``)

Expand Down
4 changes: 2 additions & 2 deletions pychievements/signals.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down