status-im
/
nimbus-eth2
mirror of https://github.com/status-im/nimbus-eth2.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

`investigated` -> `inspected` in `libnimbus_lc` docs (#5523) 

Consistently use `inspected` instead of `investigted` terminology in
documentation of `libnimbus_lc` functions.
This commit is contained in:
Etan Kissling 2023-10-24 18:09:44 +02:00 committed by GitHub
parent 5aa5095e17
commit d32fafa2ec
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 16 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
beacon_chain/libnimbus_lc/libnimbus_lc.h
View File

@ -1142,7 +1142,7 @@ void ETHTransactionsDestroy(ETHTransactions *transactions);
/** /**
* Indicates the total number of transactions in a transaction sequence. * Indicates the total number of transactions in a transaction sequence.
* *
* - Individual transactions may be investigated using `ETHTransactionsGet`. * - Individual transactions may be inspected using `ETHTransactionsGet`.
* *
* @param transactions Transaction sequence. * @param transactions Transaction sequence.
* *
@ -1352,7 +1352,7 @@ const ETHAccessList *ETHTransactionGetAccessList(const ETHTransaction *transacti
/** /**
* Indicates the total number of access tuples in a transaction access list. * Indicates the total number of access tuples in a transaction access list.
* *
* - Individual access tuples may be investigated using `ETHAccessListGet`. * - Individual access tuples may be inspected using `ETHAccessListGet`.
* *
* @param accessList Transaction access list. * @param accessList Transaction access list.
* *
@ -1401,7 +1401,7 @@ const ETHExecutionAddress *ETHAccessTupleGetAddress(const ETHAccessTuple *access
/** /**
* Indicates the total number of storage keys in an access tuple. * Indicates the total number of storage keys in an access tuple.
* *
* - Individual storage keys may be investigated using * - Individual storage keys may be inspected using
* `ETHAccessTupleGetStorageKey`. * `ETHAccessTupleGetStorageKey`.
* *
* @param accessTuple Access tuple. * @param accessTuple Access tuple.
@ -1446,7 +1446,7 @@ const uint64_t *ETHTransactionGetMaxFeePerBlobGas(const ETHTransaction *transact
/** /**
* Indicates the total number of blob versioned hashes of a transaction. * Indicates the total number of blob versioned hashes of a transaction.
* *
* - Individual blob versioned hashes may be investigated using * - Individual blob versioned hashes may be inspected using
* `ETHTransactionGetBlobVersionedHash`. * `ETHTransactionGetBlobVersionedHash`.
* *
* @param transaction Transaction. * @param transaction Transaction.
@ -1553,7 +1553,7 @@ void ETHReceiptsDestroy(ETHReceipts *receipts);
/** /**
* Indicates the total number of receipts in a receipt sequence. * Indicates the total number of receipts in a receipt sequence.
* *
* - Individual receipts may be investigated using `ETHReceiptsGet`. * - Individual receipts may be inspected using `ETHReceiptsGet`.
* *
* @param receipts Receipt sequence. * @param receipts Receipt sequence.
* *
@ -1677,7 +1677,7 @@ const ETHLogs *ETHReceiptGetLogs(const ETHReceipt *receipt);
/** /**
* Indicates the total number of logs in a log sequence. * Indicates the total number of logs in a log sequence.
* *
* - Individual logs may be investigated using `ETHLogsGet`. * - Individual logs may be inspected using `ETHLogsGet`.
* *
* @param logs Log sequence. * @param logs Log sequence.
* *
@ -1725,7 +1725,7 @@ const ETHExecutionAddress *ETHLogGetAddress(const ETHLog *log);
/** /**
* Indicates the total number of topics in a log. * Indicates the total number of topics in a log.
* *
* - Individual topics may be investigated using `ETHLogGetTopic`. * - Individual topics may be inspected using `ETHLogGetTopic`.
* *
* @param log Log. * @param log Log.
* *
@ -1788,7 +1788,7 @@ const void *ETHReceiptGetBytes(
/** /**
* Indicates the total number of withdrawals in a withdrawal sequence. * Indicates the total number of withdrawals in a withdrawal sequence.
* *
* - Individual withdrawals may be investigated using `ETHWithdrawalsGet`. * - Individual withdrawals may be inspected using `ETHWithdrawalsGet`.
* *
* @param withdrawals Withdrawal sequence. * @param withdrawals Withdrawal sequence.
* *

16
beacon_chain/libnimbus_lc/libnimbus_lc.nim
View File

@ -1650,7 +1650,7 @@ func ETHTransactionsGetCount(
transactions: ptr seq[ETHTransaction]): cint {.exported.} = transactions: ptr seq[ETHTransaction]): cint {.exported.} =
## Indicates the total number of transactions in a transaction sequence. ## Indicates the total number of transactions in a transaction sequence.
## ##
## * Individual transactions may be investigated using `ETHTransactionsGet`. ## * Individual transactions may be inspected using `ETHTransactionsGet`.
## ##
## Parameters: ## Parameters:
## * `transactions` - Transaction sequence. ## * `transactions` - Transaction sequence.
@ -1871,7 +1871,7 @@ func ETHAccessListGetCount(
accessList: ptr seq[ETHAccessTuple]): cint {.exported.} = accessList: ptr seq[ETHAccessTuple]): cint {.exported.} =
## Indicates the total number of access tuples in a transaction access list. ## Indicates the total number of access tuples in a transaction access list.
## ##
## * Individual access tuples may be investigated using `ETHAccessListGet`. ## * Individual access tuples may be inspected using `ETHAccessListGet`.
## ##
## Parameters: ## Parameters:
## * `accessList` - Transaction access list. ## * `accessList` - Transaction access list.
@ -1917,7 +1917,7 @@ func ETHAccessTupleGetNumStorageKeys(
accessTuple: ptr ETHAccessTuple): cint {.exported.} = accessTuple: ptr ETHAccessTuple): cint {.exported.} =
## Indicates the total number of storage keys in an access tuple. ## Indicates the total number of storage keys in an access tuple.
## ##
## * Individual storage keys may be investigated using ## * Individual storage keys may be inspected using
## `ETHAccessTupleGetStorageKey`. ## `ETHAccessTupleGetStorageKey`.
## ##
## Parameters: ## Parameters:
@ -1964,7 +1964,7 @@ func ETHTransactionGetNumBlobVersionedHashes(
transaction: ptr ETHTransaction): cint {.exported.} = transaction: ptr ETHTransaction): cint {.exported.} =
## Indicates the total number of blob versioned hashes of a transaction. ## Indicates the total number of blob versioned hashes of a transaction.
## ##
## * Individual blob versioned hashes may be investigated using ## * Individual blob versioned hashes may be inspected using
## `ETHTransactionGetBlobVersionedHash`. ## `ETHTransactionGetBlobVersionedHash`.
## ##
## Parameters: ## Parameters:
@ -2219,7 +2219,7 @@ func ETHReceiptsGetCount(
receipts: ptr seq[ETHReceipt]): cint {.exported.} = receipts: ptr seq[ETHReceipt]): cint {.exported.} =
## Indicates the total number of receipts in a receipt sequence. ## Indicates the total number of receipts in a receipt sequence.
## ##
## * Individual receipts may be investigated using `ETHReceiptsGet`. ## * Individual receipts may be inspected using `ETHReceiptsGet`.
## ##
## Parameters: ## Parameters:
## * `receipts` - Receipt sequence. ## * `receipts` - Receipt sequence.
@ -2346,7 +2346,7 @@ func ETHLogsGetCount(
logs: ptr seq[ETHLog]): cint {.exported.} = logs: ptr seq[ETHLog]): cint {.exported.} =
## Indicates the total number of logs in a log sequence. ## Indicates the total number of logs in a log sequence.
## ##
## * Individual logs may be investigated using `ETHLogsGet`. ## * Individual logs may be inspected using `ETHLogsGet`.
## ##
## Parameters: ## Parameters:
## * `logs` - Log sequence. ## * `logs` - Log sequence.
@ -2391,7 +2391,7 @@ func ETHLogGetNumTopics(
log: ptr ETHLog): cint {.exported.} = log: ptr ETHLog): cint {.exported.} =
## Indicates the total number of topics in a log. ## Indicates the total number of topics in a log.
## ##
## * Individual topics may be investigated using `ETHLogGetTopic`. ## * Individual topics may be inspected using `ETHLogGetTopic`.
## ##
## Parameters: ## Parameters:
## * `log` - Log. ## * `log` - Log.
@ -2465,7 +2465,7 @@ func ETHWithdrawalsGetCount(
withdrawals: ptr seq[ETHWithdrawal]): cint {.exported.} = withdrawals: ptr seq[ETHWithdrawal]): cint {.exported.} =
## Indicates the total number of withdrawals in a withdrawal sequence. ## Indicates the total number of withdrawals in a withdrawal sequence.
## ##
## * Individual withdrawals may be investigated using `ETHWithdrawalsGet`. ## * Individual withdrawals may be inspected using `ETHWithdrawalsGet`.
## ##
## Parameters: ## Parameters:
## * `withdrawals` - Withdrawal sequence. ## * `withdrawals` - Withdrawal sequence.