From e7c508e04d35aa359b55a951a9fb1cce0881534e Mon Sep 17 00:00:00 2001 From: Tim Gates Date: Thu, 9 Sep 2021 06:31:25 +1000 Subject: [PATCH] docs: Fix a few typos There are small typos in: - README.rst - docs/auth.rst - readability/clients.py - readability/utils.py Fixes: - Should read `separate` rather than `seperate`. - Should read `provides` rather than `provies`. - Should read `functions` rather than `funcitons`. - Should read `against` rather than `agains`. - Should read `accomplished` rather than `accomplised`. --- README.rst | 4 ++-- docs/auth.rst | 2 +- readability/clients.py | 2 +- readability/utils.py | 2 +- 4 files changed, 5 insertions(+), 5 deletions(-) diff --git a/README.rst b/README.rst index 4ddbbca..41107c1 100644 --- a/README.rst +++ b/README.rst @@ -25,9 +25,9 @@ Tests ----- Valid Parser, Reader, username, and password must be set as environment -variables before running the tests. This test suit runs agains the live +variables before running the tests. This test suit runs against the live Readability API and also serves as integration tests. We recommend creating a -seperate testing user account on Readability to avoid disturbing your reading +separate testing user account on Readability to avoid disturbing your reading list. **Note:** These tests do reset the bookmarks library of the provided user when complete. They should *not* be run on your primary user account! diff --git a/docs/auth.rst b/docs/auth.rst index 9e16197..c852833 100644 --- a/docs/auth.rst +++ b/docs/auth.rst @@ -5,7 +5,7 @@ Authentication three-legged oAuth flow -Authentication can be accomplised through either a |three-legged-twitter| or +Authentication can be accomplished through either a |three-legged-twitter| or via xAuth where a username and password are exchanged directly for a user token and secret. diff --git a/readability/clients.py b/readability/clients.py index 415aba1..c38b1a1 100644 --- a/readability/clients.py +++ b/readability/clients.py @@ -4,7 +4,7 @@ readability.clients ~~~~~~~~~~~~~~~~~~~ -This module provies a client for the Reader API. +This module provides a client for the Reader API. """ diff --git a/readability/utils.py b/readability/utils.py index 4e7193f..78fec4c 100644 --- a/readability/utils.py +++ b/readability/utils.py @@ -96,7 +96,7 @@ def filter_args_to_dict(filter_dict, accepted_filter_keys=[]): # Going to skip it. continue - # map of casting funcitons to filter types + # map of casting functions to filter types filter_cast_map = { 'int': cast_integer_filter, 'datetime': cast_datetime_filter