improve documentation for Python function

2022-05-02 12:12:31 -04:00 · 2022-05-02 12:12:31 -04:00 · 7bf6fb553e
parent 1c7df35c5f
commit 7bf6fb553e
1 changed files with 3 additions and 0 deletions
--- a/python/olm/sas.py
+++ b/python/olm/sas.py
@ -214,6 +214,9 @@ class Sas(object):
        # type: (str, str) -> str
        """Generate a message authentication code based on the shared secret.

+        This function uses a fixed base64 encoding that is compatible with
+        other base64 implementations.
+
        Args:
            message (str): The message to produce the authentication code for.
            extra_info (str): Extra information to mix in when generating the