Documentation for read/2 #2698
Open
Documentation for read/2 #2698
+3
−0
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Mirrored the wording in the docstrings for `read/1` and `read_term/3`.
triska
reviewed
Dec 11, 2024
src/lib/builtins.pl
Outdated
| @@ -766,6 +766,10 @@ | |||
| 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 | |||
There was a problem hiding this comment.
Regarding the phrasing "not a general predicate": Maybe this should instead clarify: "This predicate reads Prolog terms; for more general input, use for example phrase_from_file/2 or phrase_from_stream/2."
There was a problem hiding this comment.
Please note that read/2 is just here for convenience, it is a thin wrapper around read_term/3 with default options. So for me IMHO this description would be enough: "Same as read_term/3 with all default options".
Simplifying docstring.
|
That makes sense. This PR came up b/c I was looking for the docs on |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Mirrored the wording in the docstrings for
read/1andread_term/3.