Skip to content

Commit

Permalink
Improve documentation for FileStream.read_line
Browse files Browse the repository at this point in the history
The method does not necessarily read line terminating characters (for
example, at EOF).

The string returned does not contain line terminating characters.
  • Loading branch information
rrthomas authored and tintou committed Apr 6, 2024
1 parent 8c35013 commit e10da5b
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion documentation/glib-2.0/glib-2.0.valadoc
Original file line number Diff line number Diff line change
Expand Up @@ -3229,7 +3229,7 @@ GLib.FileStream.read
GLib.FileStream.write

/**
* Reads a line, including the terminating character(s), from a IOChannel into a newly-allocated string.
* Reads a line, including any line terminating character(s), from a FileStream. Returns a newly-allocated string containing the line, excluding any line terminator.
*/
GLib.FileStream.read_line

Expand Down

0 comments on commit e10da5b

Please sign in to comment.