From d180650c1b2110a81ea8b6802653093f67f78b28 Mon Sep 17 00:00:00 2001 From: ekohilas Date: Thu, 25 Oct 2018 18:18:19 +1100 Subject: [PATCH] spellchecked docs --- docs/api.rst | 2 +- docs/examples.rst | 2 +- docs/faq.rst | 2 +- docs/intro.rst | 8 ++++---- docs/testing.rst | 2 +- 5 files changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/api.rst b/docs/api.rst index e08f19b..afebc78 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -13,7 +13,7 @@ If you are looking for information on a specific function, class, or method, thi Client ------ -This is the main class of `fbchat`, which contains all the methods you use to interract with Facebook. +This is the main class of `fbchat`, which contains all the methods you use to interact with Facebook. You can extend this class, and overwrite the events, to provide custom event handling (mainly used while listening) .. autoclass:: Client(email, password, user_agent=None, max_tries=5, session_cookies=None, logging_level=logging.INFO) diff --git a/docs/examples.rst b/docs/examples.rst index 89da9dc..9b4e682 100644 --- a/docs/examples.rst +++ b/docs/examples.rst @@ -18,7 +18,7 @@ This will show basic usage of `fbchat` Interacting with Threads ------------------------ -This will interract with the thread in every way `fbchat` supports +This will interact with the thread in every way `fbchat` supports .. literalinclude:: ../examples/interract.py diff --git a/docs/faq.rst b/docs/faq.rst index 16b8c59..d4bcc1a 100644 --- a/docs/faq.rst +++ b/docs/faq.rst @@ -8,7 +8,7 @@ FAQ Version X broke my installation ------------------------------- -We try to provide backwards compatability where possible, but since we're not part of Facebook, +We try to provide backwards compatibility where possible, but since we're not part of Facebook, most of the things may be broken at any point in time Downgrade to an earlier version of fbchat, run this command diff --git a/docs/intro.rst b/docs/intro.rst index 6f5d58e..8fabddd 100644 --- a/docs/intro.rst +++ b/docs/intro.rst @@ -6,7 +6,7 @@ Introduction ============ `fbchat` uses your email and password to communicate with the Facebook server. -That means that you should always store your password in a seperate file, in case e.g. someone looks over your shoulder while you're writing code. +That means that you should always store your password in a separate file, in case e.g. someone looks over your shoulder while you're writing code. You should also make sure that the file's access control is appropriately restrictive @@ -16,7 +16,7 @@ Logging In ---------- Simply create an instance of :class:`Client`. If you have two factor authentication enabled, type the code in the terminal prompt -(If you want to supply the code in another fasion, overwrite :func:`Client.on2FACode`):: +(If you want to supply the code in another fashion, overwrite :func:`Client.on2FACode`):: from fbchat import Client from fbchat.models import * @@ -50,7 +50,7 @@ A thread can refer to two things: A Messenger group chat or a single Facebook us :class:`models.ThreadType` is an enumerator with two values: ``USER`` and ``GROUP``. These will specify whether the thread is a single user chat or a group chat. -This is required for many of `fbchat`'s functions, since Facebook differetiates between these two internally +This is required for many of `fbchat`'s functions, since Facebook differentiates between these two internally Searching for group chats and finding their ID can be done via. :func:`Client.searchForGroups`, and searching for users is possible via. :func:`Client.searchForUsers`. See :ref:`intro_fetching` @@ -141,7 +141,7 @@ Sessions -------- `fbchat` provides functions to retrieve and set the session cookies. -This will enable you to store the session cookies in a seperate file, so that you don't have to login each time you start your script. +This will enable you to store the session cookies in a separate file, so that you don't have to login each time you start your script. Use :func:`Client.getSession` to retrieve the cookies:: session_cookies = client.getSession() diff --git a/docs/testing.rst b/docs/testing.rst index a3b2f13..f7d01a0 100644 --- a/docs/testing.rst +++ b/docs/testing.rst @@ -15,7 +15,7 @@ To use the tests, copy ``tests/data.json`` to ``tests/my_data.json`` or type the Please remember to test all supported python versions. If you've made any changes to the 2FA functionality, test it with a 2FA enabled account. -If you only want to execute specific tests, pass the function names in the commandline (not including the `test_` prefix). Example:: +If you only want to execute specific tests, pass the function names in the command line (not including the `test_` prefix). Example:: $ python tests.py sendMessage sessions sendEmoji