Skip to content

Commit 3df4f3c

Browse files
committed
Fix: (plz) Docstring, documentation
1 parent 528ce2f commit 3df4f3c

File tree

2 files changed

+3
-2
lines changed

2 files changed

+3
-2
lines changed

README.org

+1-1
Original file line numberDiff line numberDiff line change
@@ -125,7 +125,7 @@ Synchronously download a JPEG file, then create an Emacs image object from the d
125125
- ~string~ to pass the response body as a decoded string.
126126
- ~response~ to pass a ~plz-response~ structure.
127127
- ~file~ to pass a temporary filename to which the response body has been saved without decoding.
128-
- ~(file ~FILENAME)~ to pass ~FILENAME~ after having saved the response body to it without decoding. ~FILENAME~ must be a non-existent file; if it exists, it will not be overwritten, and an error will be signaled.
128+
- ~(file ~FILENAME)~ to pass ~FILENAME~ after having saved the response body to it without decoding. ~FILENAME~ must be a non-existent file; if it exists, it will not be overwritten, and an error will be signaled. ~FILENAME~ is passed through ~expand-file-name~, which see.
129129
- A function, which is called in the response buffer with it narrowed to the response body (suitable for, e.g. ~json-read~).
130130

131131
If ~DECODE~ is non-nil, the response body is decoded automatically. For binary content, it should be nil. When ~AS~ is ~binary~, ~DECODE~ is automatically set to nil.

plz.el

+2-1
Original file line numberDiff line numberDiff line change
@@ -359,7 +359,8 @@ It may be:
359359
- `(file FILENAME)' to pass FILENAME after having saved the
360360
response body to it without decoding. FILENAME must be a
361361
non-existent file; if it exists, it will not be overwritten,
362-
and an error will be signaled.
362+
and an error will be signaled. FILENAME is passed through
363+
`expand-file-name', which see.
363364
364365
- A function, which is called in the response buffer with it
365366
narrowed to the response body (suitable for, e.g. `json-read').

0 commit comments

Comments
 (0)