diff --git a/docs/conf.py b/docs/conf.py index a3dadbe..500f658 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -42,7 +42,6 @@ needs_sphinx = "2.0" extensions = [ "sphinx.ext.autodoc", "sphinx.ext.intersphinx", - "sphinx.ext.todo", "sphinx.ext.viewcode", "sphinx.ext.napoleon", "sphinxcontrib.spelling", @@ -172,13 +171,6 @@ autodoc_default_options = {"members": True} # Example configuration for intersphinx: refer to the Python standard library. intersphinx_mapping = {"https://docs.python.org/": None} -# -- Options for todo extension ---------------------------------------------- - -# If true, `todo` and `todoList` produce output, else they produce nothing. -todo_include_todos = True - -todo_link_only = True - # -- Options for napoleon extension ---------------------------------------------- # Use Google style docstrings diff --git a/docs/index.rst b/docs/index.rst index 7e5c710..d5c1225 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -18,7 +18,5 @@ Documentation Overview intro examples - testing - api/index - todo faq + api/index diff --git a/docs/testing.rst b/docs/testing.rst deleted file mode 100644 index 16dbd57..0000000 --- a/docs/testing.rst +++ /dev/null @@ -1,25 +0,0 @@ -.. _testing: - -Testing -======= - -To use the tests, copy ``tests/data.json`` to ``tests/my_data.json`` or type the information manually in the terminal prompts. - -- email: Your (or a test user's) email / phone number -- password: Your (or a test user's) password -- group_thread_id: A test group that will be used to test group functionality -- user_thread_id: A person that will be used to test kick/add functionality (This user should be in the group) - -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 command line (not including the ``test_`` prefix). Example: - -.. code-block:: sh - - $ python tests.py sendMessage sessions sendEmoji - -.. warning:: - - Do not execute the full set of tests in too quick succession. This can get your account temporarily blocked for spam! - (You should execute the script at max about 10 times a day) diff --git a/docs/todo.rst b/docs/todo.rst deleted file mode 100644 index 18d063d..0000000 --- a/docs/todo.rst +++ /dev/null @@ -1,22 +0,0 @@ -.. _todo: - -Todo -==== - -This page will be periodically updated to show missing features and documentation - - -Missing Functionality ---------------------- - -- Implement ``Client.search_for_message`` - - This will use the GraphQL request API -- Implement chatting with pages properly -- Write better FAQ -- Explain usage of GraphQL - - -Documentation -------------- - -.. todolist:: diff --git a/fbchat/_client.py b/fbchat/_client.py index 0936e95..5f526aa 100644 --- a/fbchat/_client.py +++ b/fbchat/_client.py @@ -482,10 +482,7 @@ class Client: return self._read_status(False, threads, at) def mark_as_seen(self): - """ - Todo: - Documenting this - """ + # TODO: Documenting this j = self.session._payload_post( "/ajax/mercury/mark_seen.php", {"seen_timestamp": _util.now()} ) diff --git a/fbchat/_page.py b/fbchat/_page.py index 18e8a25..ff89bfe 100644 --- a/fbchat/_page.py +++ b/fbchat/_page.py @@ -8,6 +8,8 @@ from . import _session, _plan, _thread class Page(_thread.ThreadABC): """Represents a Facebook page. Implements `ThreadABC`.""" + # TODO: Implement pages properly, the implementation is lacking in a lot of places! + #: The session to use when making requests. session = attr.ib(type=_session.Session) #: The unique identifier of the page. diff --git a/fbchat/_session.py b/fbchat/_session.py index 27f2f1f..a190813 100644 --- a/fbchat/_session.py +++ b/fbchat/_session.py @@ -329,6 +329,8 @@ class Session: raise _exception.ParseError("Missing payload", data=j) from e def _graphql_requests(self, *queries): + # TODO: Explain usage of GraphQL, probably in the docs + # Perhaps provide this API as public? data = { "method": "GET", "response_format": "json",