Improve docs

sindresorhus · May 2, 2021 · d2551de · d2551de
1 parent 9aada84
commit d2551de
Show file tree

Hide file tree

Showing 2 changed files with 31 additions and 0 deletions.
diff --git a/Tests/RegexTests/RegexTests.swift b/Tests/RegexTests/RegexTests.swift
@@ -76,4 +76,18 @@ final class RegexTests: XCTestCase {
 		XCTAssertTrue(Regex(#"^foo\d+$"#) ~= "foo123")
 		XCTAssertTrue("foo123" ~= Regex(#"^foo\d+$"#))
 	}
+
+	func testMultilineOption() {
+		let regex = Regex(
+			#"""
+			^
+			[a-z]+  # Match the word
+			\d+     # Match the number
+			$
+			"""#,
+			options: .allowCommentsAndWhitespace
+		)
+
+		XCTAssertTrue(regex.isMatched(by: "foo123"))
+	}
 }
diff --git a/readme.md b/readme.md
@@ -88,6 +88,23 @@ default:
 }
 ```
 
+Multiline and comments:
+
+```swift
+let regex = Regex(
+	#"""
+	^
+	[a-z]+  # Match the word
+	\d+     # Match the number
+	$
+	"""#,
+	options: .allowCommentsAndWhitespace
+)
+
+regex.isMatched(by: "foo123")
+//=> true
+```
+
 ## API
 
 [See the API docs.](https://sindresorhus.com/Regex/Structs/Regex.html)