[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] externals/plz 1b147082c7 1/3: Docs: Update error handling
From: |
ELPA Syncer |
Subject: |
[elpa] externals/plz 1b147082c7 1/3: Docs: Update error handling |
Date: |
Thu, 16 Mar 2023 22:59:03 -0400 (EDT) |
branch: externals/plz
commit 1b147082c7561821018a58b58982149bae25ab5e
Author: Adam Porter <adam@alphapapa.net>
Commit: Adam Porter <adam@alphapapa.net>
Docs: Update error handling
---
README.org | 2 +-
plz.el | 11 ++++++-----
plz.info | 35 ++++++++++++++++++-----------------
3 files changed, 25 insertions(+), 23 deletions(-)
diff --git a/README.org b/README.org
index e2b4d0097d..e00dc6b70b 100644
--- a/README.org
+++ b/README.org
@@ -124,7 +124,7 @@ Synchronously download a JPEG file, then create an Emacs
image object from the d
~THEN~ is a callback function, whose sole argument is selected above with
~AS~. Or ~THEN~ may be ~sync~ to make a synchronous request, in which case the
result is returned directly.
- ~ELSE~ is an optional callback function called when the request fails with
one argument, a ~plz-error~ struct. If ~ELSE~ is nil, an error is signaled
when the request fails, either ~plz-curl-error~ or ~plz-http-error~ as
appropriate, with a ~plz-error~ struct as the error data. For synchronous
requests, this argument is ignored.
+ ~ELSE~ is an optional callback function called when the request fails (i.e.
if curl fails, or if the HTTP response has a non-2xx status code). It is
called with one argument, a ~plz-error~ structure. If ~ELSE~ is nil, an error
is signaled when the request fails, either ~plz-curl-error~ or ~plz-http-error~
as appropriate, with a ~plz-error~ structure as the error data. For
synchronous requests, this argument is ignored.
~FINALLY~ is an optional function called without argument after ~THEN~ or
~ELSE~, as appropriate. For synchronous requests, this argument is ignored.
diff --git a/plz.el b/plz.el
index 151c347202..071a1220a1 100644
--- a/plz.el
+++ b/plz.el
@@ -313,11 +313,12 @@ above with AS. Or THEN may be `sync' to make a
synchronous
request, in which case the result is returned directly.
ELSE is an optional callback function called when the request
-fails with one argument, a `plz-error' structure. If ELSE is
-nil, an error is signaled when the request fails, either
-`plz-curl-error' or `plz-http-error' as appropriate, with a
-`plz-error' structure as the error data. For synchronous
-requests, this argument is ignored.
+fails (i.e. if curl fails, or if the HTTP response has a non-2xx
+status code). It is called with one argument, a `plz-error'
+structure. If ELSE is nil, an error is signaled when the request
+fails, either `plz-curl-error' or `plz-http-error' as
+appropriate, with a `plz-error' structure as the error data. For
+synchronous requests, this argument is ignored.
FINALLY is an optional function called without argument after
THEN or ELSE, as appropriate. For synchronous requests, this
diff --git a/plz.info b/plz.info
index 12374ad323..be8c21e7af 100644
--- a/plz.info
+++ b/plz.info
@@ -199,11 +199,12 @@ File: README.info, Node: Functions, Next: Queueing,
Prev: Examples, Up: Usag
request, in which case the result is returned directly.
‘ELSE’ is an optional callback function called when the request
- fails with one argument, a ‘plz-error’ struct. If ‘ELSE’ is nil,
- an error is signaled when the request fails, either
- ‘plz-curl-error’ or ‘plz-http-error’ as appropriate, with a
- ‘plz-error’ struct as the error data. For synchronous requests,
- this argument is ignored.
+ fails (i.e. if curl fails, or if the HTTP response has a non-2xx
+ status code). It is called with one argument, a ‘plz-error’
+ structure. If ‘ELSE’ is nil, an error is signaled when the request
+ fails, either ‘plz-curl-error’ or ‘plz-http-error’ as appropriate,
+ with a ‘plz-error’ structure as the error data. For synchronous
+ requests, this argument is ignored.
‘FINALLY’ is an optional function called without argument after
‘THEN’ or ‘ELSE’, as appropriate. For synchronous requests, this
@@ -405,18 +406,18 @@ Node: Manual1493
Node: Usage1799
Node: Examples2300
Node: Functions3667
-Node: Queueing6562
-Node: Tips7820
-Node: Changelog8121
-Node: 04-pre8306
-Node: 039213
-Node: 0219665
-Node: 029814
-Node: 019943
-Node: Credits10037
-Node: Development10403
-Node: Copyright assignment10917
-Node: License11505
+Node: Queueing6661
+Node: Tips7919
+Node: Changelog8220
+Node: 04-pre8405
+Node: 039312
+Node: 0219764
+Node: 029913
+Node: 0110042
+Node: Credits10136
+Node: Development10502
+Node: Copyright assignment11016
+Node: License11604
End Tag Table