diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/markdown/snippets/add_str_splitlines_method.md | 3 | ||||
| -rw-r--r-- | docs/yaml/elementary/str.yml | 22 |
2 files changed, 25 insertions, 0 deletions
diff --git a/docs/markdown/snippets/add_str_splitlines_method.md b/docs/markdown/snippets/add_str_splitlines_method.md new file mode 100644 index 000000000..6787f179b --- /dev/null +++ b/docs/markdown/snippets/add_str_splitlines_method.md @@ -0,0 +1,3 @@ +## Added str.splitlines method + +[[str.splitlines]] can now be used to split a string into an array of lines. diff --git a/docs/yaml/elementary/str.yml b/docs/yaml/elementary/str.yml index 00587cbd6..dca6382a2 100644 --- a/docs/yaml/elementary/str.yml +++ b/docs/yaml/elementary/str.yml @@ -204,6 +204,28 @@ methods: type: str description: Specifies the character / substring where to split the string. +- name: splitlines + returns: list[str] + since: 1.2.0 + description: | + Splits the string into an array of lines. + Unlike .split('\n'), the empty string produced an empty array, + and if the string ends in a newline, splitlines() doesn't split + on that last newline. + '\n', '\r' and '\r\n' are all considered newlines. + + example: | + ```meson + output = 'hello\nworld\n'.splitlines() + # Output value is ['hello', 'world'] + output = ''.splitlines() + # Output value is [] + fs = import('fs') + paths = fs.read('my_paths.list').splitlines() + # paths is now the paths listed in 'my_paths.list', or an empty list + # if 'my_paths.list' is empty + ``` + # str.join() - name: join returns: str |