[Docs] Clarify write-to-file and read-from-file Behavior
#359
Conversation
This file contains hidden or 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
|
This pull request has been mentioned on Racket Discourse. There might be relevant details there: |
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.
Addresses: racket/racket#5224
If a user discovers
write-to-fileorread-from-fileand plans to leverage either without serendipitously also discovering the accompanying editor header/footer methods, they'll likely have a challenging time.Beyond simply clarifying behavior and linking to header/footer related documentation, also included @alex-hhh 's complete example within the docs for others to discover.
My first contribution. As this is documentation, no accompanying unit-tests or changelog/history updates are required.
Verification