docs: Merge #3583 3583: Revise error name to `WithdrawalNotBeneficial…

…`. r=jonathanknowles a=jonathanknowles ## Issue Number None. Noticed while reviewing #3555. ## Description This PR renames `ErrWithdrawalNotWorth` to `ErrWithdrawalNotBeneficial`. The wording of the former error name is broken. We _can_ say "a withdrawal is not worth **it**", but saying something is "not worth" (without the "it") just doesn't make sense in English. ## Compatibility Usages of the JSON error code `withdrawal_not_worth` are very rare: [Usages of `withdrawal_not_worth`](https://github.com/search?q=org%3Ainput-output-hk+%22withdrawal_not_worth%22&type=code). These rare cases can easily be updated with a tiny PR or two. Co-authored-by: Jonathan Knowles <[email protected]> Source commit: d59b05e
cardano-foundation · Nov 15, 2022 · 4b13cfd · 4b13cfd
1 parent a7319bc
commit 4b13cfd
Show file tree

Hide file tree

Showing 61 changed files with 74 additions and 69 deletions.
diff --git a/-/all.html b/-/all.html
@@ -26,7 +26,7 @@
 
 
 
-  <link href='tailwind.css?instanceId=7067e110-a606-4310-9e57-93a86cb71394' rel='stylesheet' type='text/css' />
+  <link href='tailwind.css?instanceId=0da3c3c4-780e-474d-9da7-43f22759c323' rel='stylesheet' type='text/css' />
 
   <!-- Heist error element -->
   <style type='text/css'>

diff --git a/-/tags.html b/-/tags.html
@@ -26,7 +26,7 @@
 
 
 
-  <link href='tailwind.css?instanceId=7067e110-a606-4310-9e57-93a86cb71394' rel='stylesheet' type='text/css' />
+  <link href='tailwind.css?instanceId=0da3c3c4-780e-474d-9da7-43f22759c323' rel='stylesheet' type='text/css' />
 
   <!-- Heist error element -->
   <style type='text/css'>

diff --git a/-/tasks.html b/-/tasks.html
@@ -26,7 +26,7 @@
 
 
 
-  <link href='tailwind.css?instanceId=7067e110-a606-4310-9e57-93a86cb71394' rel='stylesheet' type='text/css' />
+  <link href='tailwind.css?instanceId=0da3c3c4-780e-474d-9da7-43f22759c323' rel='stylesheet' type='text/css' />
 
   <!-- Heist error element -->
   <style type='text/css'>

diff --git a/api/edge/swagger.yaml b/api/edge/swagger.yaml
@@ -1290,14 +1290,17 @@ x-otherCertificate: &otherCertificate
 x-transactionRedemptionRequest: &transactionRedemptionRequest
   <<: *walletMnemonicSentence
   description: |
-    When provided, attempts to withdraw rewards from the default stake address corresponding to the given mnemonic.
+    When provided, attempts to withdraw rewards from the default stake address
+    corresponding to the given mnemonic.
 
-    Should the rewards be null or too small to be worth withdrawing (i.e. the cost of adding them into the transaction
-    is more than their own intrinsic value), the server will reject the request with a `withdrawal_not_worth` error.
+    Should the rewards be null or too small to be worth withdrawing (i.e. the
+    cost of adding them into the transaction is more than their own intrinsic
+    value), the server will reject the request with a
+    `withdrawal_not_beneficial` error.
 
     withdrawal field    | reward balance | result
     ---                 | ---            | ---
-    any recovery phrase | too small      | x Error 403 `withdrawal_not_worth`
+    any recovery phrase | too small      | x Error 403 `withdrawal_not_beneficial`
     any recovery phrase | big enough     | ✓ withdrawal generated
 
 x-transactionWithdrawalRequestSelf: &transactionWithdrawalRequestSelf
@@ -2759,7 +2762,7 @@ components:
         mint: *ApiAssetMintBurn
         burn: *ApiAssetMintBurn
         validity_interval: *ApiValidityIntervalExplicit
-        script_integrity: *scriptIntegrityHash 
+        script_integrity: *scriptIntegrityHash
         extra_signatures:
           type: array
           minItems: 0
@@ -4994,16 +4997,18 @@ x-errAlreadyWithdrawing: &errAlreadyWithdrawing
       enum: ['already_withdrawing']
 
 # TODO: Map this error to the place it belongs.
-x-errWithdrawalNotWorth: &errWithdrawalNotWorth
+x-errWithdrawalNotBeneficial: &errWithdrawalNotBeneficial
   <<: *responsesErr
-  title: withdrawal_not_worth
+  title: withdrawal_not_beneficial
   properties:
     message:
       type: string
-      description: May occur when withdrawing an amount would cost more than the withdrawn value.
+      description: |
+        Occurs when the cost of withdrawing a reward balance would be greater
+        than the reward balance itself.
     code:
       type: string
-      enum: ['withdrawal_not_worth']
+      enum: ['withdrawal_not_beneficial']
 
 # TODO: Map this error to the place it belongs.
 x-errPastHorizon: &errPastHorizon

diff --git a/archives.html b/archives.html
@@ -27,7 +27,7 @@
 
 
 
-  <link href='tailwind.css?instanceId=7067e110-a606-4310-9e57-93a86cb71394' rel='stylesheet' type='text/css' />
+  <link href='tailwind.css?instanceId=0da3c3c4-780e-474d-9da7-43f22759c323' rel='stylesheet' type='text/css' />
 
   <!-- Heist error element -->
   <style type='text/css'>

diff --git a/archives/jormungandr.html b/archives/jormungandr.html
@@ -27,7 +27,7 @@
 
 
 
-  <link href='tailwind.css?instanceId=7067e110-a606-4310-9e57-93a86cb71394' rel='stylesheet' type='text/css' />
+  <link href='tailwind.css?instanceId=0da3c3c4-780e-474d-9da7-43f22759c323' rel='stylesheet' type='text/css' />
 
   <!-- Heist error element -->
   <style type='text/css'>

diff --git a/archives/jormungandr/Docker-jormungandr.html b/archives/jormungandr/Docker-jormungandr.html
@@ -27,7 +27,7 @@
 
 
 
-  <link href='tailwind.css?instanceId=7067e110-a606-4310-9e57-93a86cb71394' rel='stylesheet' type='text/css' />
+  <link href='tailwind.css?instanceId=0da3c3c4-780e-474d-9da7-43f22759c323' rel='stylesheet' type='text/css' />
 
   <!-- Heist error element -->
   <style type='text/css'>

diff --git a/archives/jormungandr/cardano-wallet-jormungandr-manual.html b/archives/jormungandr/cardano-wallet-jormungandr-manual.html
@@ -27,7 +27,7 @@
 
 
 
-  <link href='tailwind.css?instanceId=7067e110-a606-4310-9e57-93a86cb71394' rel='stylesheet' type='text/css' />
+  <link href='tailwind.css?instanceId=0da3c3c4-780e-474d-9da7-43f22759c323' rel='stylesheet' type='text/css' />
 
   <!-- Heist error element -->
   <style type='text/css'>

diff --git a/concepts.html b/concepts.html
@@ -27,7 +27,7 @@
 
 
 
-  <link href='tailwind.css?instanceId=7067e110-a606-4310-9e57-93a86cb71394' rel='stylesheet' type='text/css' />
+  <link href='tailwind.css?instanceId=0da3c3c4-780e-474d-9da7-43f22759c323' rel='stylesheet' type='text/css' />
 
   <!-- Heist error element -->
   <style type='text/css'>

diff --git a/concepts/address-derivation.html b/concepts/address-derivation.html
@@ -27,7 +27,7 @@
 
 
 
-  <link href='tailwind.css?instanceId=7067e110-a606-4310-9e57-93a86cb71394' rel='stylesheet' type='text/css' />
+  <link href='tailwind.css?instanceId=0da3c3c4-780e-474d-9da7-43f22759c323' rel='stylesheet' type='text/css' />
 
   <!-- Heist error element -->
   <style type='text/css'>

diff --git a/concepts/byron-address-format.html b/concepts/byron-address-format.html
@@ -27,7 +27,7 @@
 
 
 
-  <link href='tailwind.css?instanceId=7067e110-a606-4310-9e57-93a86cb71394' rel='stylesheet' type='text/css' />
+  <link href='tailwind.css?instanceId=0da3c3c4-780e-474d-9da7-43f22759c323' rel='stylesheet' type='text/css' />
 
   <!-- Heist error element -->
   <style type='text/css'>

diff --git a/concepts/coin-selection.html b/concepts/coin-selection.html
@@ -27,7 +27,7 @@
 
 
 
-  <link href='tailwind.css?instanceId=7067e110-a606-4310-9e57-93a86cb71394' rel='stylesheet' type='text/css' />
+  <link href='tailwind.css?instanceId=0da3c3c4-780e-474d-9da7-43f22759c323' rel='stylesheet' type='text/css' />
 
   <!-- Heist error element -->
   <style type='text/css'>

diff --git a/concepts/hierarchical-deterministic-wallets.html b/concepts/hierarchical-deterministic-wallets.html
@@ -37,7 +37,7 @@
 <script async id='MathJax-script' src='https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js'></script>
 
 
-  <link href='tailwind.css?instanceId=7067e110-a606-4310-9e57-93a86cb71394' rel='stylesheet' type='text/css' />
+  <link href='tailwind.css?instanceId=0da3c3c4-780e-474d-9da7-43f22759c323' rel='stylesheet' type='text/css' />
 
   <!-- Heist error element -->
   <style type='text/css'>

diff --git a/concepts/master-key-generation.html b/concepts/master-key-generation.html
@@ -30,7 +30,7 @@
 <script src='https://cdnjs.cloudflare.com/ajax/libs/prism/1.26.0/plugins/autoloader/prism-autoloader.min.js'></script>
 
 
-  <link href='tailwind.css?instanceId=7067e110-a606-4310-9e57-93a86cb71394' rel='stylesheet' type='text/css' />
+  <link href='tailwind.css?instanceId=0da3c3c4-780e-474d-9da7-43f22759c323' rel='stylesheet' type='text/css' />
 
   <!-- Heist error element -->
   <style type='text/css'>

diff --git a/concepts/recovery-phrases.html b/concepts/recovery-phrases.html
@@ -31,7 +31,7 @@
 <script async id='MathJax-script' src='https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js'></script>
 
 
-  <link href='tailwind.css?instanceId=7067e110-a606-4310-9e57-93a86cb71394' rel='stylesheet' type='text/css' />
+  <link href='tailwind.css?instanceId=0da3c3c4-780e-474d-9da7-43f22759c323' rel='stylesheet' type='text/css' />
 
   <!-- Heist error element -->
   <style type='text/css'>

diff --git a/concepts/transaction-lifecycle.html b/concepts/transaction-lifecycle.html
@@ -49,7 +49,7 @@
 </script>
 
 
-  <link href='tailwind.css?instanceId=7067e110-a606-4310-9e57-93a86cb71394' rel='stylesheet' type='text/css' />
+  <link href='tailwind.css?instanceId=0da3c3c4-780e-474d-9da7-43f22759c323' rel='stylesheet' type='text/css' />
 
   <!-- Heist error element -->
   <style type='text/css'>

diff --git a/concepts/utxo.html b/concepts/utxo.html
@@ -27,7 +27,7 @@
 
 
 
-  <link href='tailwind.css?instanceId=7067e110-a606-4310-9e57-93a86cb71394' rel='stylesheet' type='text/css' />
+  <link href='tailwind.css?instanceId=0da3c3c4-780e-474d-9da7-43f22759c323' rel='stylesheet' type='text/css' />
 
   <!-- Heist error element -->
   <style type='text/css'>

diff --git a/contributing.html b/contributing.html
@@ -27,7 +27,7 @@
 
 
 
-  <link href='tailwind.css?instanceId=7067e110-a606-4310-9e57-93a86cb71394' rel='stylesheet' type='text/css' />
+  <link href='tailwind.css?instanceId=0da3c3c4-780e-474d-9da7-43f22759c323' rel='stylesheet' type='text/css' />
 
   <!-- Heist error element -->
   <style type='text/css'>

diff --git a/contributing/Hydra.html b/contributing/Hydra.html
@@ -27,7 +27,7 @@
 
 
 
-  <link href='tailwind.css?instanceId=7067e110-a606-4310-9e57-93a86cb71394' rel='stylesheet' type='text/css' />
+  <link href='tailwind.css?instanceId=0da3c3c4-780e-474d-9da7-43f22759c323' rel='stylesheet' type='text/css' />
 
   <!-- Heist error element -->
   <style type='text/css'>

diff --git a/contributing/Logging-Guidelines.html b/contributing/Logging-Guidelines.html
@@ -27,7 +27,7 @@
 
 
 
-  <link href='tailwind.css?instanceId=7067e110-a606-4310-9e57-93a86cb71394' rel='stylesheet' type='text/css' />
+  <link href='tailwind.css?instanceId=0da3c3c4-780e-474d-9da7-43f22759c323' rel='stylesheet' type='text/css' />
 
   <!-- Heist error element -->
   <style type='text/css'>

diff --git a/contributing/Nix.html b/contributing/Nix.html
@@ -27,7 +27,7 @@
 
 
 
-  <link href='tailwind.css?instanceId=7067e110-a606-4310-9e57-93a86cb71394' rel='stylesheet' type='text/css' />
+  <link href='tailwind.css?instanceId=0da3c3c4-780e-474d-9da7-43f22759c323' rel='stylesheet' type='text/css' />
 
   <!-- Heist error element -->
   <style type='text/css'>

diff --git a/contributing/Notes-from-upgrading-GHC-version.html b/contributing/Notes-from-upgrading-GHC-version.html
@@ -27,7 +27,7 @@
 
 
 
-  <link href='tailwind.css?instanceId=7067e110-a606-4310-9e57-93a86cb71394' rel='stylesheet' type='text/css' />
+  <link href='tailwind.css?instanceId=0da3c3c4-780e-474d-9da7-43f22759c323' rel='stylesheet' type='text/css' />
 
   <!-- Heist error element -->
   <style type='text/css'>

diff --git a/contributing/Release-Process.html b/contributing/Release-Process.html
@@ -27,7 +27,7 @@
 
 
 
-  <link href='tailwind.css?instanceId=7067e110-a606-4310-9e57-93a86cb71394' rel='stylesheet' type='text/css' />
+  <link href='tailwind.css?instanceId=0da3c3c4-780e-474d-9da7-43f22759c323' rel='stylesheet' type='text/css' />
 
   <!-- Heist error element -->
   <style type='text/css'>

diff --git a/contributing/Swagger-Development.html b/contributing/Swagger-Development.html
@@ -27,7 +27,7 @@
 
 
 
-  <link href='tailwind.css?instanceId=7067e110-a606-4310-9e57-93a86cb71394' rel='stylesheet' type='text/css' />
+  <link href='tailwind.css?instanceId=0da3c3c4-780e-474d-9da7-43f22759c323' rel='stylesheet' type='text/css' />
 
   <!-- Heist error element -->
   <style type='text/css'>

diff --git a/contributing/Testing.html b/contributing/Testing.html
@@ -27,7 +27,7 @@
 
 
 
-  <link href='tailwind.css?instanceId=7067e110-a606-4310-9e57-93a86cb71394' rel='stylesheet' type='text/css' />
+  <link href='tailwind.css?instanceId=0da3c3c4-780e-474d-9da7-43f22759c323' rel='stylesheet' type='text/css' />
 
   <!-- Heist error element -->
   <style type='text/css'>

diff --git a/contributing/Updating-Dependencies.html b/contributing/Updating-Dependencies.html
@@ -27,7 +27,7 @@
 
 
 
-  <link href='tailwind.css?instanceId=7067e110-a606-4310-9e57-93a86cb71394' rel='stylesheet' type='text/css' />
+  <link href='tailwind.css?instanceId=0da3c3c4-780e-474d-9da7-43f22759c323' rel='stylesheet' type='text/css' />
 
   <!-- Heist error element -->
   <style type='text/css'>

diff --git a/design.html b/design.html
@@ -27,7 +27,7 @@
 
 
 
-  <link href='tailwind.css?instanceId=7067e110-a606-4310-9e57-93a86cb71394' rel='stylesheet' type='text/css' />
+  <link href='tailwind.css?instanceId=0da3c3c4-780e-474d-9da7-43f22759c323' rel='stylesheet' type='text/css' />
 
   <!-- Heist error element -->
   <style type='text/css'>

diff --git a/design/Eras.html b/design/Eras.html
@@ -27,7 +27,7 @@
 
 
 
-  <link href='tailwind.css?instanceId=7067e110-a606-4310-9e57-93a86cb71394' rel='stylesheet' type='text/css' />
+  <link href='tailwind.css?instanceId=0da3c3c4-780e-474d-9da7-43f22759c323' rel='stylesheet' type='text/css' />
 
   <!-- Heist error element -->
   <style type='text/css'>

diff --git a/design/Notes-about-BIP-44.html b/design/Notes-about-BIP-44.html
@@ -27,7 +27,7 @@
 
 
 
-  <link href='tailwind.css?instanceId=7067e110-a606-4310-9e57-93a86cb71394' rel='stylesheet' type='text/css' />
+  <link href='tailwind.css?instanceId=0da3c3c4-780e-474d-9da7-43f22759c323' rel='stylesheet' type='text/css' />
 
   <!-- Heist error element -->
   <style type='text/css'>

diff --git a/design/Specifying-exceptions-with-Servant-and-Swagger.html b/design/Specifying-exceptions-with-Servant-and-Swagger.html
@@ -27,7 +27,7 @@
 
 
 
-  <link href='tailwind.css?instanceId=7067e110-a606-4310-9e57-93a86cb71394' rel='stylesheet' type='text/css' />
+  <link href='tailwind.css?instanceId=0da3c3c4-780e-474d-9da7-43f22759c323' rel='stylesheet' type='text/css' />
 
   <!-- Heist error element -->
   <style type='text/css'>

diff --git a/design/WalletId.html b/design/WalletId.html
@@ -41,7 +41,7 @@
 <script async id='MathJax-script' src='https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js'></script>
 
 
-  <link href='tailwind.css?instanceId=7067e110-a606-4310-9e57-93a86cb71394' rel='stylesheet' type='text/css' />
+  <link href='tailwind.css?instanceId=0da3c3c4-780e-474d-9da7-43f22759c323' rel='stylesheet' type='text/css' />
 
   <!-- Heist error element -->
   <style type='text/css'>

diff --git a/design/records.html b/design/records.html
@@ -27,7 +27,7 @@
 
 
 
-  <link href='tailwind.css?instanceId=7067e110-a606-4310-9e57-93a86cb71394' rel='stylesheet' type='text/css' />
+  <link href='tailwind.css?instanceId=0da3c3c4-780e-474d-9da7-43f22759c323' rel='stylesheet' type='text/css' />
 
   <!-- Heist error element -->
   <style type='text/css'>

diff --git a/design/records/2021-01-17-nix-flake.html b/design/records/2021-01-17-nix-flake.html
@@ -27,7 +27,7 @@
 
 
 
-  <link href='tailwind.css?instanceId=7067e110-a606-4310-9e57-93a86cb71394' rel='stylesheet' type='text/css' />
+  <link href='tailwind.css?instanceId=0da3c3c4-780e-474d-9da7-43f22759c323' rel='stylesheet' type='text/css' />
 
   <!-- Heist error element -->
   <style type='text/css'>

diff --git a/design/specs.html b/design/specs.html
@@ -27,7 +27,7 @@
 
 
 
-  <link href='tailwind.css?instanceId=7067e110-a606-4310-9e57-93a86cb71394' rel='stylesheet' type='text/css' />
+  <link href='tailwind.css?instanceId=0da3c3c4-780e-474d-9da7-43f22759c323' rel='stylesheet' type='text/css' />
 
   <!-- Heist error element -->
   <style type='text/css'>

diff --git a/design/specs/light-mode.html b/design/specs/light-mode.html
@@ -49,7 +49,7 @@
 </script>
 
 
-  <link href='tailwind.css?instanceId=7067e110-a606-4310-9e57-93a86cb71394' rel='stylesheet' type='text/css' />
+  <link href='tailwind.css?instanceId=0da3c3c4-780e-474d-9da7-43f22759c323' rel='stylesheet' type='text/css' />
 
   <!-- Heist error element -->
   <style type='text/css'>

diff --git a/developers.html b/developers.html
@@ -27,7 +27,7 @@
 
 
 
-  <link href='tailwind.css?instanceId=7067e110-a606-4310-9e57-93a86cb71394' rel='stylesheet' type='text/css' />
+  <link href='tailwind.css?instanceId=0da3c3c4-780e-474d-9da7-43f22759c323' rel='stylesheet' type='text/css' />
 
   <!-- Heist error element -->
   <style type='text/css'>

diff --git a/developers/Architecture.html b/developers/Architecture.html
@@ -49,7 +49,7 @@
 </script>
 
 
-  <link href='tailwind.css?instanceId=7067e110-a606-4310-9e57-93a86cb71394' rel='stylesheet' type='text/css' />
+  <link href='tailwind.css?instanceId=0da3c3c4-780e-474d-9da7-43f22759c323' rel='stylesheet' type='text/css' />
 
   <!-- Heist error element -->
   <style type='text/css'>

diff --git a/developers/Building.html b/developers/Building.html
@@ -27,7 +27,7 @@
 
 
 
-  <link href='tailwind.css?instanceId=7067e110-a606-4310-9e57-93a86cb71394' rel='stylesheet' type='text/css' />
+  <link href='tailwind.css?instanceId=0da3c3c4-780e-474d-9da7-43f22759c323' rel='stylesheet' type='text/css' />
 
   <!-- Heist error element -->
   <style type='text/css'>

diff --git a/developers/Resources.html b/developers/Resources.html
@@ -27,7 +27,7 @@
 
 
 
-  <link href='tailwind.css?instanceId=7067e110-a606-4310-9e57-93a86cb71394' rel='stylesheet' type='text/css' />
+  <link href='tailwind.css?instanceId=0da3c3c4-780e-474d-9da7-43f22759c323' rel='stylesheet' type='text/css' />
 
   <!-- Heist error element -->
   <style type='text/css'>