branch: externals-release/plz
commit 3df4f3c0a3e6843b1b9dc6a0dda2ea95399bde08
Author: Adam Porter <a...@alphapapa.net>
Commit: Adam Porter <a...@alphapapa.net>
Fix: (plz) Docstring, documentation
---
README.org | 2 +-
plz.el | 3 ++-
2 files changed, 3 insertions(+), 2 deletions(-)
diff --git a/README.org b/README.org
index 7c27a40aeb..06cb9861c4 100644
--- a/README.org
+++ b/README.org
@@ -125,7 +125,7 @@ Synchronously download a JPEG file, then create an Emacs
image object from the d
- ~string~ to pass the response body as a decoded string.
- ~response~ to pass a ~plz-response~ structure.
- ~file~ to pass a temporary filename to which the response body has been
saved without decoding.
- - ~(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.
+ - ~(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.
- A function, which is called in the response buffer with it narrowed to
the response body (suitable for, e.g. ~json-read~).
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.
diff --git a/plz.el b/plz.el
index 7425f155a3..f34710f77d 100644
--- a/plz.el
+++ b/plz.el
@@ -359,7 +359,8 @@ It may be:
- `(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.
+ and an error will be signaled. FILENAME is passed through
+ `expand-file-name', which see.
- A function, which is called in the response buffer with it
narrowed to the response body (suitable for, e.g. `json-read').
