Merge remote-tracking branch 'upstream/main' into np/pull-upstream

xmtp · Jun 20, 2024 · 9fa3f99 · 9fa3f99
2 parents 99b2d5e + 12c7331
commit 9fa3f99
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 6 deletions.
diff --git a/openmls/src/group/core_group/new_from_welcome.rs b/openmls/src/group/core_group/new_from_welcome.rs
@@ -228,7 +228,7 @@ pub(in crate::group) fn build_staged_welcome<Provider: OpenMlsProvider>(
     Ok(group)
 }
 
-/// Process a Welcome message up to the point where the ratchet tree is is required.
+/// Process a Welcome message up to the point where the ratchet tree is required.
 pub(in crate::group) fn process_welcome<Provider: OpenMlsProvider>(
     welcome: Welcome,
     key_package_bundle: &KeyPackageBundle,

diff --git a/openmls/src/group/mls_group/creation.rs b/openmls/src/group/mls_group/creation.rs
@@ -148,8 +148,8 @@ fn transpose_err_opt<T, E>(v: Result<Option<T>, E>) -> Option<Result<T, E>> {
 }
 
 impl ProcessedWelcome {
-    /// Creates a new processed [`Welcome`] message that can be used to parse
-    /// it before creating a [`StagedWelcome`].
+    /// Creates a new processed [`Welcome`] message , which can be
+    /// inspected before creating a [`StagedWelcome`].
     ///
     /// This does not require a ratchet tree yet.
     ///

diff --git a/openmls/src/group/mls_group/mod.rs b/openmls/src/group/mls_group/mod.rs
@@ -495,12 +495,12 @@ pub struct StagedWelcome {
     group: StagedCoreWelcome,
 }
 
-/// A parsed, but not fully processed `Welcome` message.
+/// A `Welcome` message that has been processed but not staged yet.
 ///
 /// This may be used in order to retrieve information from the `Welcome` about
-/// the ratchet tree.
+/// the ratchet tree and PSKs.
 ///
-/// Use `into_staged_welcome` to get the [`StagedWelcome`] on this.
+/// Use `into_staged_welcome` to stage it into a [`StagedWelcome`].
 pub struct ProcessedWelcome {
     // The group configuration. See [`MlsGroupJoinConfig`] for more information.
     mls_group_config: MlsGroupJoinConfig,