Fix spelling mistakes in documentation

This commit is contained in:
Mads Marquart
2019-07-24 00:08:39 +02:00
parent edf14cfd84
commit cc9d81a39e
19 changed files with 106 additions and 105 deletions

View File

@@ -30,8 +30,8 @@ This will show the different ways of fetching information about users and thread
.. literalinclude:: ../examples/fetch.py
Echobot
-------
``Echobot``
-----------
This will reply to any message with the same message

View File

@@ -9,7 +9,7 @@ Version X broke my installation
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
Downgrade to an earlier version of ``fbchat``, run this command
.. code-block:: sh
@@ -28,7 +28,7 @@ Submitting Issues
-----------------
If you're having trouble with some of the snippets, or you think some of the functionality is broken,
please feel free to submit an issue on `Github <https://github.com/carpedm20/fbchat>`_.
please feel free to submit an issue on `GitHub <https://github.com/carpedm20/fbchat>`_.
You should first login with ``logging_level`` set to ``logging.DEBUG``::
from fbchat import Client

View File

@@ -6,8 +6,8 @@
.. This documentation's layout is heavily inspired by requests' layout: https://requests.readthedocs.io
Some documentation is also partially copied from facebook-chat-api: https://github.com/Schmavery/facebook-chat-api
fbchat: Facebook Chat (Messenger) for Python
============================================
``fbchat``: Facebook Chat (Messenger) for Python
================================================
Release v\ |version|. (:ref:`install`)
@@ -35,7 +35,7 @@ This means doing the exact same GET/POST requests and tricking Facebook into thi
Therefore, this API requires the credentials of a Facebook account.
.. note::
If you're having problems, please check the :ref:`faq`, before asking questions on Github
If you're having problems, please check the :ref:`faq`, before asking questions on GitHub
.. warning::
We are not responsible if your account gets banned for spammy activities,
@@ -44,7 +44,7 @@ Therefore, this API requires the credentials of a Facebook account.
.. note::
Facebook now has an `official API <https://developers.facebook.com/docs/messenger-platform>`_ for chat bots,
so if you're familiar with node.js, this might be what you're looking for.
so if you're familiar with ``Node.js``, this might be what you're looking for.
If you're already familiar with the basics of how Facebook works internally, go to :ref:`examples` to see example usage of ``fbchat``

View File

@@ -3,10 +3,10 @@
Installation
============
Pip Install fbchat
------------------
Install using pip
-----------------
To install fbchat, run this command:
To install ``fbchat``, run this command:
.. code-block:: sh
@@ -19,7 +19,7 @@ can guide you through the process.
Get the Source Code
-------------------
fbchat is developed on GitHub, where the code is
``fbchat`` is developed on GitHub, where the code is
`always available <https://github.com/carpedm20/fbchat>`_.
You can either clone the public repository:

View File

@@ -24,7 +24,7 @@ Replace ``<email>`` and ``<password>`` with your email and password respectively
.. note::
For ease of use then most of the code snippets in this document will assume you've already completed the login process
Though the second line, ``from fbchat.models import *``, is not strictly neccesary here, later code snippets will assume you've done this
Though the second line, ``from fbchat.models import *``, is not strictly necessary here, later code snippets will assume you've done this
If you want to change how verbose ``fbchat`` is, change the logging level (in :class:`Client`)
@@ -125,8 +125,8 @@ The following snippet will search for users by their name, take the first (and m
user = users[0]
print("User's ID: {}".format(user.uid))
print("User's name: {}".format(user.name))
print("User's profile picture url: {}".format(user.photo))
print("User's main url: {}".format(user.url))
print("User's profile picture URL: {}".format(user.photo))
print("User's main URL: {}".format(user.url))
Since this uses Facebook's search functions, you don't have to specify the whole name, first names will usually be enough
@@ -154,7 +154,7 @@ Or you can set the ``session_cookies`` on your initial login.
client = Client('<email>', '<password>', session_cookies=session_cookies)
.. warning::
You session cookies can be just as valueable as you password, so store them with equal care
You session cookies can be just as valuable as you password, so store them with equal care
.. _intro_events:
@@ -192,7 +192,7 @@ The change was in the parameters that our `onMessage` method took: ``message_obj
and ``mid``, ``ts``, ``metadata`` and ``msg`` got removed, but the function still works, since we included ``**kwargs``
.. note::
Therefore, for both backwards and forwards compatability,
Therefore, for both backwards and forwards compatibility,
the API actually requires that you include ``**kwargs`` as your final argument.
View the :ref:`examples` to see some more examples illustrating the event system

View File

@@ -9,11 +9,11 @@ This page will be periodically updated to show missing features and documentatio
Missing Functionality
---------------------
- Implement Client.searchForMessage
- This will use the graphql request API
- Implement ``Client.searchForMessage``
- This will use the GraphQL request API
- Implement chatting with pages properly
- Write better FAQ
- Explain usage of graphql
- Explain usage of GraphQL
Documentation