Code review changes

Author: omus

README.md

@@ -10,7 +10,7 @@ Tooling for manipulating multiline strings.
 
 ## Features
 
-The package features the `@m_str` macro, inspired from [YAML's block scalars](https://yaml-multiline.info/), which provide options for manipulating multiline strings via a style and chomp indicator:
+The package features a multiline string literal (`@m_str`), inspired from [YAML's block scalars](https://yaml-multiline.info/), which provide options for manipulating multiline string literals via a style and chomp indicator:
 
 - Style indicator:
     - `f` replace newlines with spaces (folded)
@@ -52,3 +52,5 @@ to this function doesn't contain magic that may interfere with
 with the non-magical computation occurring on this device.
 """
 ```
+
+Take note that a Julia [triple-quoted string literal](https://docs.julialang.org/en/v1/manual/strings/#Triple-Quoted-String-Literals) will leave most newlines in place.

src/MultilineStrings.jl

@@ -104,7 +104,8 @@ function multiline(str::AbstractString, style::Symbol, chomp::Symbol)
 
     # Replace newlines with spaces (folded)
     if style === :folded
-        # The code below is equivalent to these two regexes:
+        # The code below is equivalent to these two regexes (the non-regex code has much
+        # better performance):
         # ```
         # str = replace(str, r"(?<=\S)\n(?=\S)" => " ")
         # str = replace(str, r"(?<=\n)\n(?=\S)" => "")
@@ -180,17 +181,19 @@ end
 """
     @m_str -> String
 
-Construct a multiline string according to a style and chomp indicators (provided after the
-ending quote):
+Manipulate a multiline string literal according to a style and chomp indicator (provided
+after the ending quote):
 
 - Style indicator:
-    - `f` replace newlines with spaces (folded)
+    - `f` replace newlines with spaces (folded, default)
     - `l` keep newlines (literal)
 - Chomp indicator:
-    - `s` no newlines at the end (strip)
+    - `s` no newlines at the end (strip, default)
     - `c` single newline at the end (clip)
     - `k` keep all newlines from the end (keep)
 
+If both a style and chomp indicator is provided the style indicator must be specified first.
+
 Note string interpolation is still respected any newlines added from interpolation will be
 also be processed.