Merge pull request #4 from invenia/cv/corrections

Corrections
JuliaStrings · Sep 2, 2020 · 3192dbf · 3192dbf · omus · Sep 2, 2020
2 parents 29e85b4 + 0e88525
commit 3192dbf
Showing 1 changed file with 5 additions and 6 deletions.
diff --git a/src/MultilineStrings.jl b/src/MultilineStrings.jl
@@ -1,16 +1,15 @@
 module MultilineStrings
 
-export @m_str
+export @m_str, multiline
 
-const ETX = '\x03'  # ASCII control character: End of Text
 const DEFAULT_STYLE = :folded
 const DEFAULT_CHOMP = :strip
 
 """
-    multiline(str, style=$(repr(DEFAULT_STYLE)), chomp=$(repr(DEFAULT_CHOMP))) -> AbstractString
+    multiline(str; style=$(repr(DEFAULT_STYLE)), chomp=$(repr(DEFAULT_CHOMP))) -> AbstractString
 
-Create a multiline string according to the provided `style` and `chomp`. Works similarly to
-YAML multiline strings (also known as block scalars).
+Manipulate a multiline string according to the provided `style` and `chomp`. Works similarly
+to YAML multiline strings (also known as block scalars).
 
 # Arguments
 - `str::AbstractString`: The multiline string to be processed
@@ -27,7 +26,7 @@ end
 """
     multiline(str, indicators) -> AbstractString
 
-Revise a multiline string according to the provided style and chomp encoded in the
+Manipulate a multiline string according to the provided style and chomp encoded in the
 `indicators` string.
 
 # Arguments