Skip to content

docs: add hint about how to reset an invitation#8160

Open
r10s wants to merge 2 commits intomainfrom
r10s/improve-check-qr-doc
Open

docs: add hint about how to reset an invitation#8160
r10s wants to merge 2 commits intomainfrom
r10s/improve-check-qr-doc

Conversation

@r10s
Copy link
Copy Markdown
Contributor

@r10s r10s commented Apr 23, 2026

this PR adds a hint about how to reset a QR code.

the API is as-is, just now, a refactoring here is also unwanted. the jsonrpc documentation needs to improved in general, this is known, and also not done by this PR

closes #7985

@r10s r10s requested review from Hocuri and adbenitez April 23, 2026 22:54
@r10s r10s marked this pull request as draft April 23, 2026 23:00
@r10s r10s force-pushed the r10s/improve-check-qr-doc branch from d6f5901 to 86d035b Compare April 23, 2026 23:30
@r10s r10s changed the title docs: improve check_qr() documentation docs: add hint about how to reset an invitation Apr 23, 2026
@r10s r10s marked this pull request as ready for review April 23, 2026 23:32
@r10s r10s force-pushed the r10s/improve-check-qr-doc branch from 86d035b to 7bd1429 Compare April 23, 2026 23:33
Comment thread deltachat-jsonrpc/src/api.rs Outdated
Co-authored-by: adb <asieldbenitez@gmail.com>
@r10s r10s enabled auto-merge (squash) April 23, 2026 23:41
Comment thread deltachat-ffi/deltachat.h


/**
* Get QR code text that will offer an Setup-Contact or Verified-Group invitation.
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* Get QR code text (https:-link) that will offer an Setup-Contact or Verified-Group invitation.

Otherwise only one paragraph in the middle says that an https:-link is returned, so it may be unclear which link is meant w/o reading all the paragraphs

@@ -883,6 +883,8 @@ impl CommandApi {

/// Get QR code text that will offer a [SecureJoin](https://securejoin.delta.chat/) invitation.
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
/// Get QR code text that will offer a [SecureJoin](https://securejoin.delta.chat/) invitation.
/// Get QR code text (https:-link) that will offer a [SecureJoin](https://securejoin.delta.chat/) invitation.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Document get_chat_securejoin_qr_code(), check_qr(), set_config_from_qr() (particularly, QR code withdrawal)

4 participants