gui icon indicating copy to clipboard operation
gui copied to clipboard

[Docs] Clarify `write-to-file` and `read-from-file` Behavior

Open robertDurst opened this issue 5 months ago • 1 comments

Addresses: https://github.com/racket/racket/issues/5224

If a user discovers write-to-file or read-from-file and 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

  • [x] raco setup ran successfully
  • [x] docs looked good locally

robertDurst avatar Sep 09 '25 02:09 robertDurst

This pull request has been mentioned on Racket Discourse. There might be relevant details there:

https://racket.discourse.group/t/how-to-serialize-deserialize-text-editors-and-structures-including-text-editors/3605/8

Thanks! I updated the branch to avoid a merge conflict and to shift the "See also File Format" to after your explanation.

mflatt avatar Jan 07 '26 14:01 mflatt