Improve types and docs of {import,export}SecretsBundle
#123
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
richvdh
force-pushed
the
rav/qr-login-types
branch
from
d3daeff
to
0152de9
Compare
|
cc @poljar since you wrote the original PR |
richvdh
changed the title
{import,export}SecretsBundle{import,export}SecretsBundle
richvdh
commented
Jun 3, 2024
Comment on lines
+537
to
+538
| /// Export all the secrets we have in the store into a {@link | ||
| /// SecretsBundle}. |
There was a problem hiding this comment.
Since this documentation is used by typedoc, we have to use link formats that it understands.
(Note that currently the documentation at https://matrix-org.github.io/matrix-rust-sdk-crypto-wasm/classes/OlmMachine.html#importSecretsBundle doesn't link correctly).
richvdh
commented
Jun 3, 2024
Comment on lines
+567
to
+568
| /// The provided `SecretsBundle` is freed by this method; be careful not to | ||
| /// use it once this method has been called. |
There was a problem hiding this comment.
invalidating an argument is a very non-JS thing to do, so let's call it out explicitly.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Followup on #118
cf #110