Mirrors/chatmail-core
1
0
Fork 0
mirror of https://github.com/chatmail/core.git synced 2026-05-07 08:56:30 +03:00
Code Issues Packages Projects Releases Wiki Activity

fix doc strings for qr-code joinings

Browse Source
This commit is contained in:
holger krekel
2023-11-01 13:10:01 +01:00
parent bd02eea66b
commit 71b7b0b393
1 changed files with 8 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
python/src/deltachat/account.py
View File

@@ -571,11 +571,11 @@ class Account:
return ScannedQRCode(lot) return ScannedQRCode(lot)
def qr_setup_contact(self, qr): def qr_setup_contact(self, qr):
"""setup contact and return a Chat after contact is established. """setup contact and return a `Chat` instance after contact is established.
This function triggers a network protocol in the background between
the emitter of the QR code and this account.
Note that this function may block for a long time as messages are exchanged
with the emitter of the QR code. On success a :class:`deltachat.chat.Chat` instance
is returned.
:param qr: valid "setup contact" QR code (all other QR codes will result in an exception) :param qr: valid "setup contact" QR code (all other QR codes will result in an exception)
""" """
assert self.check_qr(qr).is_ask_verifycontact() assert self.check_qr(qr).is_ask_verifycontact()
@@ -585,11 +585,11 @@ class Account:
return Chat(self, chat_id) return Chat(self, chat_id)
def qr_join_chat(self, qr): def qr_join_chat(self, qr):
"""join a chat group through a QR code. """return a `Chat` instance for which the securejoin network
protocol has been started.
Note that this function may block for a long time as messages are exchanged This function triggers a network protocol in the background between
with the emitter of the QR code. On success a :class:`deltachat.chat.Chat` instance the emitter of the QR code and this account.
is returned which is the chat that we just joined.
:param qr: valid "join-group" QR code (all other QR codes will result in an exception) :param qr: valid "join-group" QR code (all other QR codes will result in an exception)
""" """