Small doc fixes

Author: madsmtm

CONTRIBUTING.rst

@@ -35,8 +35,8 @@ Checklist
 
 Once you're done with your work, please follow the steps below:
 
-- Run `black .` to format your code.
-- Run `pytest` to test your code.
-- Run `make -C docs html` to verify that the docs still work.
-- Run `make -C docs spelling` to check your spelling in docstrings.
+- Run ``black .`` to format your code.
+- Run ``pytest`` to test your code.
+- Run ``make -C docs html``, and view the generated docs, to verify that the docs still work.
+- Run ``make -C docs spelling`` to check your spelling in docstrings.
 - Create a pull request, and point it to ``master`` `here <https://github.com/carpedm20/fbchat/pulls/new>`__.

README.rst

@@ -1,17 +1,17 @@
 ``fbchat`` - Facebook Messenger for Python
 ==========================================
 
-.. image:: https://badgen.net/pypi/license/fbchat
-    :target: https://github.com/carpedm20/fbchat/tree/master/LICENSE
-    :alt: License: BSD 3-Clause
+.. image:: https://badgen.net/pypi/v/fbchat
+    :target: https://pypi.python.org/pypi/fbchat
+    :alt: Project version
 
 .. image:: https://badgen.net/badge/python/3.5,3.6,3.7,3.8,pypy?list=|
     :target: https://pypi.python.org/pypi/fbchat
     :alt: Supported python versions: 3.5, 3.6, 3.7, 3.8 and pypy
 
-.. image:: https://badgen.net/pypi/v/fbchat
-    :target: https://pypi.python.org/pypi/fbchat
-    :alt: Project version
+.. image:: https://badgen.net/pypi/license/fbchat
+    :target: https://github.com/carpedm20/fbchat/tree/master/LICENSE
+    :alt: License: BSD 3-Clause
 
 .. image:: https://readthedocs.org/projects/fbchat/badge/?version=stable
     :target: https://fbchat.readthedocs.io
@@ -26,7 +26,7 @@
     :alt: Code style
 
 A powerful and efficient library to interact with
-`Facebook\'s Messenger <https://www.facebook.com/messages/>`__, using just your email and password.
+`Facebook's Messenger <https://www.facebook.com/messages/>`__, using just your email and password.
 
 This is *not* an official API, Facebook has that `over here <https://developers.facebook.com/docs/messenger-platform>`__ for chat bots. This library differs by using a normal Facebook account instead.
 
@@ -36,15 +36,15 @@ This is *not* an official API, Facebook has that `over here <https://developers.
 - Fetching all messages, threads and images in threads.
 - Searching for messages and threads.
 - Creating groups, setting the group emoji, changing nicknames, creating polls, etc.
-- Listening for, an reacting to events in real-time.
-- Type hints, and a modern codebase (e.g. only Python 3.5 and upwards).
+- Listening for, an reacting to messages and other events in real-time.
+- Type hints, and it has a modern codebase (e.g. only Python 3.5 and upwards).
 - ``async``/``await`` (COMING).
 
 Essentially, everything you need to make an amazing Facebook bot!
 
 
-Version warning:
-----------------
+Version Warning
+---------------
 ``v2`` is currently being developed at the ``master`` branch and it's highly unstable. If you want to view the old ``v1``, go `here <https://github.com/carpedm20/fbchat/tree/v1>`__.
 
 Additionally, you can view the project's progress `here <https://github.com/carpedm20/fbchat/projects/2>`__.
@@ -86,7 +86,7 @@ You can also install directly from source, provided you have ``pip>=19.0``:
 .. inclusion-marker-installation-end
 
 
-Example usage
+Example Usage
 -------------
 
 .. code-block::

docs/api/index.rst

@@ -1,5 +1,4 @@
 .. module:: fbchat
-.. _api:
 
 .. Note: we're using () to hide the __init__ method where relevant
 

docs/conf.py

@@ -162,7 +162,7 @@
 
 # -- Options for autodoc extension ---------------------------------------
 
-autoclass_content = "both"
+autoclass_content = "class"
 autodoc_member_order = "bysource"
 autodoc_default_options = {"members": True}
 

docs/faq.rst

@@ -6,7 +6,7 @@ The new version broke my application
 
 ``fbchat`` follows `Scemantic Versioning <https://semver.org/>`__ quite rigorously!
 
-That means that breaking changes can *only* occur in major versions (e.g. `v1.9.6` -> `v2.0.0`).
+That means that breaking changes can *only* occur in major versions (e.g. ``v1.9.6`` -> ``v2.0.0``).
 
 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!
 

fbchat/_thread.py

@@ -110,7 +110,7 @@ def send_text(
             reply_to_id: Optional message to reply to
 
         Returns:
-            :ref:`Message ID <intro_message_ids>` of the sent message
+            The sent message
         """
         data = self._to_send_data()
         data["action_type"] = "ma-type:user-generated-message"
@@ -139,7 +139,7 @@ def send_emoji(self, emoji: str, size: "_message.EmojiSize") -> str:
             size: The size of the emoji
 
         Returns:
-            :ref:`Message ID <intro_message_ids>` of the sent message
+            The sent message
         """
         data = self._to_send_data()
         data["action_type"] = "ma-type:user-generated-message"
@@ -154,7 +154,7 @@ def send_sticker(self, sticker_id: str) -> str:
             sticker_id: ID of the sticker to send
 
         Returns:
-            :ref:`Message ID <intro_message_ids>` of the sent message
+            The sent message
         """
         data = self._to_send_data()
         data["action_type"] = "ma-type:user-generated-message"