docs(lib): improve docs of doom-file-read/-write

This commit is contained in:
Tim Ruffing 2023-12-21 17:59:51 +01:00 committed by Henrik Lissner
parent 1ee429406b
commit 2b54b5732c

View file

@ -245,7 +245,8 @@ special values:
'read* -- read all forms in FILE and return it as a list of S-exps. 'read* -- read all forms in FILE and return it as a list of S-exps.
'(read . N) -- read the first N (an integer) S-exps in FILE. '(read . N) -- read the first N (an integer) S-exps in FILE.
CODING dictates the encoding of the buffer. This defaults to `utf-8'. CODING dictates the encoding of the buffer. This defaults to `utf-8'. If set to
nil, `binary' is used.
If NOERROR is non-nil, don't throw an error if FILE doesn't exist. This will If NOERROR is non-nil, don't throw an error if FILE doesn't exist. This will
still throw an error if FILE is unreadable, however. still throw an error if FILE is unreadable, however.
@ -305,7 +306,7 @@ MODE dictates the permissions of the file. If FILE already exists, its
permissions will be changed. permissions will be changed.
CODING dictates the encoding to read/write with (see `coding-system-for-write'). CODING dictates the encoding to read/write with (see `coding-system-for-write').
If set to nil, `binary' is used. This defaults to `utf-8'. If set to nil, `binary' is used.
APPEND dictates where CONTENTS will be written. If neither is set, APPEND dictates where CONTENTS will be written. If neither is set,
the file will be overwritten. If both are, the contents will be written to both the file will be overwritten. If both are, the contents will be written to both