Document read return status

Fixes #3711.
2024-11-26 10:43:47 +08:00 · 2017-01-07 14:19:04 +01:00 · 2017-01-07 14:19:04 +01:00 · e1b445f934
commit e1b445f934
parent 19c038d1ef
1 changed files with 1 additions and 0 deletions
--- a/doc_src/read.txt
+++ b/doc_src/read.txt
@ -43,6 +43,7 @@ If `-a` or `--array` is provided, only one variable name is allowed and the toke

 See the documentation for `set` for more details on the scoping rules for variables.

+When read reaches the end-of-file (EOF) instead of the separator, it returns 1. If not, it returns 0.

 \subsection read-example Example