Documentation for read/2

Mirrored the wording in the docstrings for `read/1` and `read_term/3`.

diff --git a/src/lib/builtins.pl b/src/lib/builtins.pl
index b62632183ad83793bb241d6028e078ccce01c2b6..e2513cc4089e53db88a16b3b05d0c505d0a510cf 100644 (file)
--- a/src/lib/builtins.pl
+++ b/src/lib/builtins.pl
@@ -766,6 +766,10 @@ read(Term) :-
     read_term(Stream, Term, []).
     % read(Stream, Term).
 
+%% read(+Stream, -Term).
+%
+% Read Term from the stream Stream with default options. **NOTE** This is not a general predicate
+% to read input from a file or the user. Use other predicates like `phrase_from_file/2` for that.
 read(Stream, Term) :-
     read_term(Stream, Term, []).