From 8211f3d6f1f90f9e7ac85a7b8d6277535345d0e5 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Maxime=20=E2=80=9Cpep=E2=80=9D=20Buquet?=
Date: Tue, 2 Jul 2019 00:07:34 +0200
Subject: e2ee-api: Some more changes to the documentation
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
Signed-off-by: Maxime “pep” Buquet
---
doc/source/dev/e2ee.rst | 5 +----
poezio/plugin_e2ee.py | 12 ++++++------
2 files changed, 7 insertions(+), 10 deletions(-)
diff --git a/doc/source/dev/e2ee.rst b/doc/source/dev/e2ee.rst
index 08cae715..23304512 100644
--- a/doc/source/dev/e2ee.rst
+++ b/doc/source/dev/e2ee.rst
@@ -8,11 +8,8 @@ E2EEPlugin
.. autoclass:: E2EEPlugin
- :members:
+ :members: decrypt, encrypt, encryption_name, encryption_short_name, eme_ns, replace_body_with_eme, stanza_encryption, tag_whitelist
-Builds on top of :py:class:`~BasePlugin` and requires the developer to
-implement two methods, `decrypt` and `encrypt`, as well as the
-`encryption_name` and `eme_ns` attribute.
Please refer to :py:class:`~BasePlugin` for more information on how to
write plugins.
diff --git a/poezio/plugin_e2ee.py b/poezio/plugin_e2ee.py
index 4e4eec2a..0c66e32a 100644
--- a/poezio/plugin_e2ee.py
+++ b/poezio/plugin_e2ee.py
@@ -56,10 +56,10 @@ class E2EEPlugin(BasePlugin):
"""
#: Specifies that the encryption mechanism does more than encrypting
- #: .
+ #: ``.
stanza_encryption = False
- #: Whitelist applied to messages when `stanza_encryption` is False.
+ #: Whitelist applied to messages when `stanza_encryption` is `False`.
tag_whitelist = list(map(lambda x: '{%s}%s' % (x[0], x[1]), [
(JCLIENT_NS, 'body'),
(EME_NS, EME_TAG),
@@ -71,9 +71,9 @@ class E2EEPlugin(BasePlugin):
]))
#: Replaces body with `eme `_
- #: if set. Should be suitable for most plugins except those using
- #: directly as their encryption container, like OTR, or the example base64
- #: plugin in poezio.
+ #: if set. Should be suitable for most plugins except those using
+ #: `` directly as their encryption container, like OTR, or the
+ #: example base64 plugin in poezio.
replace_body_with_eme = True
#: Encryption name, used in command descriptions, and logs. At least one
@@ -85,7 +85,7 @@ class E2EEPlugin(BasePlugin):
#: `encryption_short_name` must be set.
encryption_short_name = None # type: Optional[str]
- #: Required.
+ #: Required.