Add newline inclusive disclaimer #1770
Merged
+2
−2
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Hi, I got confused due to some ambiguity with the readline and readlines function.
I propose adding a disclaimer that the newline character is also included.
Some extra references about similar functions within Python
splitlines
has the argumentkeeplinebreaks
to make this choice for including or excluding newlines explicit. It defaults to removing the newline.https://www.w3schools.com/python/ref_string_splitlines.asp
The documentation of
readlines
also doesn't state anything about including or excluding the newlines. It defaults to keeping the newline: similar to the fsspec implementation.https://www.w3schools.com/python/ref_file_readlines.asp