From e82662647fa70655508172f6fa1a6d424371698f Mon Sep 17 00:00:00 2001 From: Vaclav Barta Date: Wed, 9 Mar 2022 15:25:42 +0100 Subject: [PATCH] started updating docs --- xrpl-hooks-docs/md/hooks-account-buf-len.md | 5 ++--- xrpl-hooks-docs/md/hooks-account-conv-buf-len.md | 6 ++---- xrpl-hooks-docs/md/hooks-account-conv-pure.md | 9 ++------- xrpl-hooks-docs/md/hooks-array-buf-len.md | 8 ++------ xrpl-hooks-docs/md/hooks-burden-prereq.md | 4 +--- xrpl-hooks-docs/md/hooks-detail-buf-len.md | 5 ++--- xrpl-hooks-docs/md/hooks-detail-prereq.md | 4 +--- xrpl-hooks-docs/md/hooks-emit-buf-len.md | 5 ++--- xrpl-hooks-docs/md/hooks-emit-prereq.md | 4 +--- xrpl-hooks-docs/md/hooks-entry-point-recursion.md | 5 +++-- xrpl-hooks-docs/md/hooks-entry-points-neg.md | 5 +++-- xrpl-hooks-docs/md/hooks-entry-points.md | 5 +++-- xrpl-hooks-docs/md/hooks-fee-prereq.md | 4 +--- 13 files changed, 25 insertions(+), 44 deletions(-) diff --git a/xrpl-hooks-docs/md/hooks-account-buf-len.md b/xrpl-hooks-docs/md/hooks-account-buf-len.md index ac3f7d8..e7d3ec7 100644 --- a/xrpl-hooks-docs/md/hooks-account-buf-len.md +++ b/xrpl-hooks-docs/md/hooks-account-buf-len.md @@ -1,6 +1,5 @@ # hooks-account-buf-len -Function `hook_account` has fixed-size account ID output. +Function [hook_account](https://xrpl-hooks.readme.io/reference/hook_account) has fixed-size account ID output. -This check warns about too-small size of its output buffer (if it's -specified by a constant - variable parameter is ignored). +This check warns about too-small size of its output buffer (if it's specified by a constant - variable parameter is ignored). diff --git a/xrpl-hooks-docs/md/hooks-account-conv-buf-len.md b/xrpl-hooks-docs/md/hooks-account-conv-buf-len.md index 835c6b0..82a9ad5 100644 --- a/xrpl-hooks-docs/md/hooks-account-conv-buf-len.md +++ b/xrpl-hooks-docs/md/hooks-account-conv-buf-len.md @@ -1,7 +1,5 @@ # hooks-account-conv-buf-len -Function `util_raddr` has fixed-size account ID input. +Function [util_raddr](https://xrpl-hooks.readme.io/reference/util_raddr) has fixed-size account ID input. -This check warns unless the correct size is passed in the input size -parameter (if it's specified by a constant - variable parameter is -ignored). +This check warns unless the correct size is passed in the input size parameter (if it's specified by a constant - variable parameter is ignored). diff --git a/xrpl-hooks-docs/md/hooks-account-conv-pure.md b/xrpl-hooks-docs/md/hooks-account-conv-pure.md index a87cf9c..732b0e9 100644 --- a/xrpl-hooks-docs/md/hooks-account-conv-pure.md +++ b/xrpl-hooks-docs/md/hooks-account-conv-pure.md @@ -1,10 +1,5 @@ # hooks-account-conv-pure -Hooks identify accounts by the 20 byte account ID, which can be -converted to an raddr using the `util_raddr` function. If the account -ID never changes, a more efficient way to do this is precompute the -raddr from the account ID. +Hooks identify accounts by the 20 byte account ID, which can be converted to an raddr using the [util_raddr](https://xrpl-hooks.readme.io/reference/util_raddr) function. If the account ID never changes, a more efficient way to do this is precompute the raddr from the account ID. -This check warns about calls of `util_raddr` with constant input and -proposes to add a tracing statement showing the computed value (so -that the user can use it to replace the call). +This check warns about calls of `util_raddr` with constant input and proposes to add a tracing statement showing the computed value (so that the user can use it to replace the call). diff --git a/xrpl-hooks-docs/md/hooks-array-buf-len.md b/xrpl-hooks-docs/md/hooks-array-buf-len.md index 4f1aaac..3b3b981 100644 --- a/xrpl-hooks-docs/md/hooks-array-buf-len.md +++ b/xrpl-hooks-docs/md/hooks-array-buf-len.md @@ -1,9 +1,5 @@ # hooks-array-buf-len -Hook API `sto_subarray` requires non-empty input buffer and takes a -parameter specifying the array index, whose value is limited - the -sought object cannot be found if the limit is exceeded. +Hook API [sto_subarray](https://xrpl-hooks.readme.io/reference/sto_subarray) requires non-empty input buffer and takes a parameter specifying the array index, whose value is limited - the sought object cannot be found if the limit is exceeded. -This check warns about empty input as well as too-large values of the -index specified in calls to `sto_subarray` (if they're specified by -constants - variable parameters are ignored). +This check warns about empty input as well as too-large values of the index specified in calls to `sto_subarray` (if they're specified by constants - variable parameters are ignored). diff --git a/xrpl-hooks-docs/md/hooks-burden-prereq.md b/xrpl-hooks-docs/md/hooks-burden-prereq.md index cc40a1f..cca78d5 100644 --- a/xrpl-hooks-docs/md/hooks-burden-prereq.md +++ b/xrpl-hooks-docs/md/hooks-burden-prereq.md @@ -1,5 +1,3 @@ # hooks-burden-prereq -Hook API `etxn_burden` computes transaction burden, based on (i.a.) -the number of reserved transactions, so a call to it must be preceded -by a call to `etxn_reserve`. +Hook API [etxn_burden](https://xrpl-hooks.readme.io/reference/etxn_burden) computes transaction burden, based on (i.a.) the number of reserved transactions, so a call to it must be preceded by a call to [etxn_reserve](https://xrpl-hooks.readme.io/reference/etxn_reserve). diff --git a/xrpl-hooks-docs/md/hooks-detail-buf-len.md b/xrpl-hooks-docs/md/hooks-detail-buf-len.md index 96563d7..8a9f20a 100644 --- a/xrpl-hooks-docs/md/hooks-detail-buf-len.md +++ b/xrpl-hooks-docs/md/hooks-detail-buf-len.md @@ -1,6 +1,5 @@ # hooks-detail-buf-len -Function `etxn_details` has fixed-size sfEmitDetails output. +Function [etxn_details](https://xrpl-hooks.readme.io/reference/etxn_details) has fixed-size sfEmitDetails output. -This check warns about too-small size of its output buffer (if it's -specified by a constant - variable parameter is ignored). +This check warns about too-small size of its output buffer (if it's specified by a constant - variable parameter is ignored). diff --git a/xrpl-hooks-docs/md/hooks-detail-prereq.md b/xrpl-hooks-docs/md/hooks-detail-prereq.md index a48917d..d5444c7 100644 --- a/xrpl-hooks-docs/md/hooks-detail-prereq.md +++ b/xrpl-hooks-docs/md/hooks-detail-prereq.md @@ -1,5 +1,3 @@ # hooks-detail-prereq -Hook API `etxn_details` serializes emit details, based on (i.a.) the -number of reserved transactions, so a call to it must be preceded by a -call to `etxn_reserve`. +Hook API [etxn_details](https://xrpl-hooks.readme.io/reference/etxn_details) serializes emit details, based on (i.a.) the number of reserved transactions, so a call to it must be preceded by a call to [etxn_reserve](https://xrpl-hooks.readme.io/reference/etxn_reserve). diff --git a/xrpl-hooks-docs/md/hooks-emit-buf-len.md b/xrpl-hooks-docs/md/hooks-emit-buf-len.md index 76f6d68..def86c2 100644 --- a/xrpl-hooks-docs/md/hooks-emit-buf-len.md +++ b/xrpl-hooks-docs/md/hooks-emit-buf-len.md @@ -1,6 +1,5 @@ # hooks-emit-buf-len -Function `emit` has fixed-size transaction hash output. +Function [emit](https://xrpl-hooks.readme.io/reference/emit) has fixed-size transaction hash output. -This check warns about too-small size of its output buffer (if it's -specified by a constant - variable parameter is ignored). +This check warns about too-small size of its output buffer (if it's specified by a constant - variable parameter is ignored). diff --git a/xrpl-hooks-docs/md/hooks-emit-prereq.md b/xrpl-hooks-docs/md/hooks-emit-prereq.md index 2fbd561..f3ed81c 100644 --- a/xrpl-hooks-docs/md/hooks-emit-prereq.md +++ b/xrpl-hooks-docs/md/hooks-emit-prereq.md @@ -1,5 +1,3 @@ # hooks-emit-prereq -Before emitting a transaction using `emit` Hook API, a hook must set a -maximal count of transactions it plans to emit, by calling -`etxn_reserve`. +Before emitting a transaction using [emit](https://xrpl-hooks.readme.io/reference/emit) Hook API, a hook must set a maximal count of transactions it plans to emit, by calling [etxn_reserve](https://xrpl-hooks.readme.io/reference/etxn_reserve). diff --git a/xrpl-hooks-docs/md/hooks-entry-point-recursion.md b/xrpl-hooks-docs/md/hooks-entry-point-recursion.md index e287894..3207439 100644 --- a/xrpl-hooks-docs/md/hooks-entry-point-recursion.md +++ b/xrpl-hooks-docs/md/hooks-entry-point-recursion.md @@ -1,4 +1,5 @@ # hooks-entry-point-recursion -Recursive calls are disallowed in the implementation of hook entry -points. +Recursive calls are disallowed in the implementation of hook entry points. + +[Read more](https://xrpl-hooks.readme.io/docs/loops-and-guarding#no-recursion) diff --git a/xrpl-hooks-docs/md/hooks-entry-points-neg.md b/xrpl-hooks-docs/md/hooks-entry-points-neg.md index faa03ad..04da687 100644 --- a/xrpl-hooks-docs/md/hooks-entry-points-neg.md +++ b/xrpl-hooks-docs/md/hooks-entry-points-neg.md @@ -1,4 +1,5 @@ # hooks-entry-points-neg -Shows error on function definitions with unexpected (that is, neither -`hook` nor `cbak`) names. +Shows error on function definitions with unexpected (that is, neither `hook` nor `cbak`) names. + +[Read more](https://xrpl-hooks.readme.io/docs/compiling-hooks) diff --git a/xrpl-hooks-docs/md/hooks-entry-points.md b/xrpl-hooks-docs/md/hooks-entry-points.md index c0618dc..bc6421a 100644 --- a/xrpl-hooks-docs/md/hooks-entry-points.md +++ b/xrpl-hooks-docs/md/hooks-entry-points.md @@ -1,6 +1,7 @@ # hooks-entry-points -A Hook always implements and exports exactly two functions: `cbak` and -`hook`. +A Hook always implements and exports exactly two functions: [cbak](https://xrpl-hooks.readme.io/reference/cbak) and [hook](https://xrpl-hooks.readme.io/reference/hook). This check shows error on translation units that do not have them. + +[Read more](https://xrpl-hooks.readme.io/docs/compiling-hooks) diff --git a/xrpl-hooks-docs/md/hooks-fee-prereq.md b/xrpl-hooks-docs/md/hooks-fee-prereq.md index c25f9e8..97c48bb 100644 --- a/xrpl-hooks-docs/md/hooks-fee-prereq.md +++ b/xrpl-hooks-docs/md/hooks-fee-prereq.md @@ -1,5 +1,3 @@ # hooks-fee-prereq -Hook API `etxn_fee_base` estimates a transaction fee, based on (i.a.) -the number of reserved transactions, so a call to it must be preceded -by a call to `etxn_reserve`. +Hook API [etxn_fee_base](https://xrpl-hooks.readme.io/reference/etxn_fee_base) estimates a transaction fee, based on (i.a.) the number of reserved transactions, so a call to it must be preceded by a call to [etxn_reserve](https://xrpl-hooks.readme.io/reference/etxn_reserve).