diff --git a/src/MultilineStrings.jl b/src/MultilineStrings.jl index bdae9db..ce8c2d6 100644 --- 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