karaolidis/fbchat
Archived
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Clean up FAQ

Browse Source
This commit is contained in:
Mads Marquart
2020-01-22 23:14:31 +01:00
parent 3d3b0f9e91
commit 55ef9979c3
1 changed files with 11 additions and 30 deletions
Download Patch File Download Diff File Expand all files Collapse all files

41
docs/faq.rst
View File

@@ -1,42 +1,23 @@
.. _faq:
Frequently Asked Questions
==========================
FAQ
===
The new version broke my application
------------------------------------
Version X broke my installation
-------------------------------
``fbchat`` follows `Scemantic Versioning <https://semver.org/>`__ quite rigorously!
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
That means that breaking changes can *only* occur in major versions (e.g. `v1.9.6` -> `v2.0.0`).
Downgrade to an earlier version of ``fbchat``, run this command
If you find that something breaks, and you didn't update to a new major version, then it is a bug, and we would be grateful if you reported it!
In case you're stuck with an old codebase, you can downgrade to a previous version of ``fbchat``, e.g. version ``1.9.6``:
.. code-block:: sh
$ pip install fbchat==<X>
Where you replace ``<X>`` with the version you want to use
$ pip install fbchat==1.9.6
Will you be supporting creating posts/events/pages and so on?
-------------------------------------------------------------
We won't be focusing on anything else than chat-related things. This API is called ``fbCHAT``, after all ;)
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>`_.
You should first login with ``logging_level`` set to ``logging.DEBUG``::
from fbchat import Client
import logging
client = Client('<email>', '<password>', logging_level=logging.DEBUG)
Then you can submit the relevant parts of this log, and detailed steps on how to reproduce
.. warning::
Always remove your credentials from any debug information you may provide us.
Preferably, use a test account, in case you miss anything
We won't be focusing on anything else than chat-related things. This library is called ``fbCHAT``, after all!