From 7aa3c26bec2cbbd6d7c202b102e0c8d22d93aa19 Mon Sep 17 00:00:00 2001
From: Sima Nerush <2002ssn@gmail.com>
Date: Sat, 23 Dec 2023 18:05:07 -0800
Subject: [PATCH] [Docs] Add details for
 `addMaterializePackExpansionConstraint`

---
 include/swift/Sema/Constraint.h       |  2 +-
 include/swift/Sema/ConstraintSystem.h | 13 ++++++++-----
 2 files changed, 9 insertions(+), 6 deletions(-)

diff --git a/include/swift/Sema/Constraint.h b/include/swift/Sema/Constraint.h
index 4c30b5e46a777..bb5c5208dbf8d 100644
--- a/include/swift/Sema/Constraint.h
+++ b/include/swift/Sema/Constraint.h
@@ -219,7 +219,7 @@ enum class ConstraintKind : char {
   /// Both (first and second) pack types should have the same reduced shape.
   SameShape,
   /// The first type is a tuple containing a single unlabeled element that is a
-  /// pack expansion. The second type is that pack expansion.
+  /// pack expansion. The second type is its pattern type.
   MaterializePackExpansion,
 };
 
diff --git a/include/swift/Sema/ConstraintSystem.h b/include/swift/Sema/ConstraintSystem.h
index de3d92a00730e..834bb0fa574cf 100644
--- a/include/swift/Sema/ConstraintSystem.h
+++ b/include/swift/Sema/ConstraintSystem.h
@@ -3823,14 +3823,17 @@ class ConstraintSystem {
   /// Given a tuple with a single unlabeled element that represents a pack
   /// expansion (either directly via \c PackExpansionType or through a type
   /// variable constrained to a pack expansion), materialize the pack expansion
-  /// and return its pattern type as a result. The result is a type variable
-  /// because element of the tuple is not required to be resolved at the time of
-  /// the call and operation is delayed until the element is sufficiently
-  /// resolved (see \c simplifyMaterializePackExpansionConstraint)
+  /// and return its pattern type as a result. The result is a type
+  /// variable because element of the tuple is not required to be resolved at
+  /// the time of the call and operation is delayed until the element is
+  /// sufficiently resolved (see \c simplifyMaterializePackExpansionConstraint)
   ///
   /// \param tupleType A tuple with a single unlabeled element that represents a
-  /// pack expansion. 
+  /// pack expansion.
   /// \param locator The locator.
+  ///
+  /// \returns A type variable type that represents the pattern type of the pack
+  /// expansion.
   TypeVariableType *
   addMaterializePackExpansionConstraint(Type tupleType,
                                         ConstraintLocatorBuilder locator);