docs: Fix a few typos (#824)

There are small typos in:
- docs/configuration.rst
- i3pystatus/calendar/google.py
- i3pystatus/coin.py
- i3pystatus/core/modules.py
- i3pystatus/ping.py
- i3pystatus/sabnzbd.py
- i3pystatus/timer.py

Fixes:
- Should read `occurred` rather than `occured`.
- Should read `subtracts` rather than `substracts`.
- Should read `specify` rather than `specifiy`.
- Should read `remaining` rather than `remainig`.
- Should read `recommended` rather than `recomended`.
- Should read `property` rather than `propertie`.
- Should read `available` rather than `availible`.
This commit is contained in:
Tim Gates 2021-08-30 23:58:04 +10:00 committed by GitHub
parent 3bd37173a1
commit 3e9f61dff0
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
7 changed files with 10 additions and 10 deletions

View File

@ -136,7 +136,7 @@ If no arguments were provided, ``i3pystatus`` script works as an example of
Formatting Formatting
---------- ----------
All modules let you specifiy the exact output formatting using a All modules let you specify the exact output formatting using a
`format string <http://docs.python.org/3/library/string.html#formatstrings>`_, which `format string <http://docs.python.org/3/library/string.html#formatstrings>`_, which
gives you a great deal of flexibility. gives you a great deal of flexibility.

View File

@ -57,7 +57,7 @@ class Google(CalendarBackend):
this will open a browser window for auth, and save a token to `credential_path`. you will need to reload i3poystatus this will open a browser window for auth, and save a token to `credential_path`. you will need to reload i3poystatus
afterwards afterwards
If you already have a token `credentials_json` is not required (though highly recomended incase your token gets broken) If you already have a token `credentials_json` is not required (though highly recommended incase your token gets broken)
.. rubric:: Available formatters .. rubric:: Available formatters

View File

@ -8,7 +8,7 @@ from i3pystatus.core.util import internet, require
class Coin(IntervalModule): class Coin(IntervalModule):
""" """
Fetches live data of all cryptocurrencies availible at coinmarketcap <https://coinmarketcap.com/>. Fetches live data of all cryptocurrencies available at coinmarketcap <https://coinmarketcap.com/>.
Coin setting should be equal to the 'id' field of your coin in <https://api.coinmarketcap.com/v1/ticker/>. Coin setting should be equal to the 'id' field of your coin in <https://api.coinmarketcap.com/v1/ticker/>.
Example coin settings: bitcoin, bitcoin-cash, ethereum, litecoin, dash, lisk. Example coin settings: bitcoin, bitcoin-cash, ethereum, litecoin, dash, lisk.

View File

@ -215,7 +215,7 @@ class Module(SettingsBase):
:param button: The ID of button event received from i3bar. :param button: The ID of button event received from i3bar.
:param kwargs: Further information received from i3bar like the :param kwargs: Further information received from i3bar like the
positions of the mouse where the click occured. positions of the mouse where the click occurred.
:return: Returns ``True`` if a valid callback action was executed. :return: Returns ``True`` if a valid callback action was executed.
``False`` otherwise. ``False`` otherwise.
""" """

View File

@ -8,7 +8,7 @@ class Ping(IntervalModule):
This module display the ping value between your computer and a host. This module display the ping value between your computer and a host.
``switch_state`` callback can disable the Ping when desired. ``switch_state`` callback can disable the Ping when desired.
``host`` propertie can be changed for set a specific host. ``host`` property can be changed for set a specific host.
.. rubric:: Available formatters .. rubric:: Available formatters

View File

@ -62,7 +62,7 @@ class sabnzbd(IntervalModule):
answer = json.loads(answer) answer = json.loads(answer)
# if answer["status"] exists and is False, an error occured # if answer["status"] exists and is False, an error occurred
if not answer.get("status", True): if not answer.get("status", True):
self.output = { self.output = {
"full_text": answer["error"], "full_text": answer["error"],

View File

@ -57,7 +57,7 @@ class Timer(IntervalModule):
Two new event settings were added: Two new event settings were added:
- ``on_overflow`` - Executed when remaining time reaches zero. - ``on_overflow`` - Executed when remaining time reaches zero.
- ``on_reset`` - Executed when timer is reset but only if overflow occured. - ``on_reset`` - Executed when timer is reset but only if overflow occurred.
These settings accept either a python callable object or a string with shell These settings accept either a python callable object or a string with shell
command. command.
@ -159,9 +159,9 @@ class Timer(IntervalModule):
def increase(self, seconds): def increase(self, seconds):
""" """
Change remainig time value. Change remaining time value.
:param int seconds: Seconds to add. Negative value substracts from :param int seconds: Seconds to add. Negative value subtracts from
remaining time. remaining time.
""" """
if self.state is TimerState.running: if self.state is TimerState.running:
@ -171,7 +171,7 @@ class Timer(IntervalModule):
def reset(self): def reset(self):
""" """
Stop timer and execute ``on_reset`` if overflow occured. Stop timer and execute ``on_reset`` if overflow occurred.
""" """
if self.state is not TimerState.stopped: if self.state is not TimerState.stopped:
if self.on_reset and self.state is TimerState.overflow: if self.on_reset and self.state is TimerState.overflow: