Skip to content

Commit 04a5f33

Browse files
rjan90strmfos
andauthored
chore: fix comments in .go (#12903)
* Update api_full.go * Update api_storage.go * chore: make gen chore: make gen --------- Co-authored-by: comfsrt <[email protected]>
1 parent 97dc186 commit 04a5f33

File tree

6 files changed

+6
-6
lines changed

6 files changed

+6
-6
lines changed

api/api_full.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ type FullNode interface {
9090
// Returns:
9191
// - *types.IndexValidation: A pointer to an IndexValidation struct containing the results of the validation/backfill.
9292
// - error: An error object if the validation/backfill fails. The error message will contain details about the index
93-
// corruption if the call fails because of an incosistency between indexed data and the actual chain state.
93+
// corruption if the call fails because of an inconsistency between indexed data and the actual chain state.
9494
// Note: The API returns an error if the index does not have data for the specified epoch and backfill is set to false.
9595
ChainValidateIndex(ctx context.Context, epoch abi.ChainEpoch, backfill bool) (*types.IndexValidation, error) //perm:write
9696

api/api_storage.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -215,7 +215,7 @@ type StorageMiner interface {
215215
// in this instance.
216216
RuntimeSubsystems(ctx context.Context) (MinerSubsystems, error) //perm:read
217217

218-
// CreateBackup creates node backup onder the specified file name. The
218+
// CreateBackup creates node backup under the specified file name. The
219219
// method requires that the lotus-miner is running with the
220220
// LOTUS_BACKUP_BASE_PATH environment variable set to some path, and that
221221
// the path specified when calling CreateBackup is within the base path

build/openrpc/full.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2012,7 +2012,7 @@
20122012
{
20132013
"name": "Filecoin.ChainValidateIndex",
20142014
"description": "```go\nfunc (s *FullNodeStruct) ChainValidateIndex(p0 context.Context, p1 abi.ChainEpoch, p2 bool) (*types.IndexValidation, error) {\n\tif s.Internal.ChainValidateIndex == nil {\n\t\treturn nil, ErrNotSupported\n\t}\n\treturn s.Internal.ChainValidateIndex(p0, p1, p2)\n}\n```",
2015-
"summary": "ChainValidateIndex validates the integrity of and optionally backfills\nthe chain index at a specific epoch.\n\nIt can be used to:\n\n1. Validate the chain index at a specific epoch:\n - Ensures consistency between indexed data and actual chain state\n - Reports any errors found during validation (i.e. the indexed data does not match the actual chain state, missing data, etc.)\n\n2. Optionally backfill missing data:\n - Backfills data if the index is missing information for the specified epoch\n - Backfilling only occurs when the `backfill` parameter is set to `true`\n\n3. Detect \"holes\" in the index:\n - If `backfill` is `false` and the index lacks data for the specified epoch, the API returns an error indicating missing data\n\nParameters:\n - epoch: The specific chain epoch for which to validate/backfill the index.\n - backfill: A boolean flag indicating whether to attempt backfilling of missing data if the index does not have data for the\n specified epoch.\n\nReturns:\n - *types.IndexValidation: A pointer to an IndexValidation struct containing the results of the validation/backfill.\n - error: An error object if the validation/backfill fails. The error message will contain details about the index\n corruption if the call fails because of an incosistency between indexed data and the actual chain state.\n Note: The API returns an error if the index does not have data for the specified epoch and backfill is set to false.\n",
2015+
"summary": "ChainValidateIndex validates the integrity of and optionally backfills\nthe chain index at a specific epoch.\n\nIt can be used to:\n\n1. Validate the chain index at a specific epoch:\n - Ensures consistency between indexed data and actual chain state\n - Reports any errors found during validation (i.e. the indexed data does not match the actual chain state, missing data, etc.)\n\n2. Optionally backfill missing data:\n - Backfills data if the index is missing information for the specified epoch\n - Backfilling only occurs when the `backfill` parameter is set to `true`\n\n3. Detect \"holes\" in the index:\n - If `backfill` is `false` and the index lacks data for the specified epoch, the API returns an error indicating missing data\n\nParameters:\n - epoch: The specific chain epoch for which to validate/backfill the index.\n - backfill: A boolean flag indicating whether to attempt backfilling of missing data if the index does not have data for the\n specified epoch.\n\nReturns:\n - *types.IndexValidation: A pointer to an IndexValidation struct containing the results of the validation/backfill.\n - error: An error object if the validation/backfill fails. The error message will contain details about the index\n corruption if the call fails because of an inconsistency between indexed data and the actual chain state.\n Note: The API returns an error if the index does not have data for the specified epoch and backfill is set to false.\n",
20162016
"paramStructure": "by-position",
20172017
"params": [
20182018
{

build/openrpc/miner.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -748,7 +748,7 @@
748748
{
749749
"name": "Filecoin.CreateBackup",
750750
"description": "```go\nfunc (s *StorageMinerStruct) CreateBackup(p0 context.Context, p1 string) error {\n\tif s.Internal.CreateBackup == nil {\n\t\treturn ErrNotSupported\n\t}\n\treturn s.Internal.CreateBackup(p0, p1)\n}\n```",
751-
"summary": "CreateBackup creates node backup onder the specified file name. The\nmethod requires that the lotus-miner is running with the\nLOTUS_BACKUP_BASE_PATH environment variable set to some path, and that\nthe path specified when calling CreateBackup is within the base path\n",
751+
"summary": "CreateBackup creates node backup under the specified file name. The\nmethod requires that the lotus-miner is running with the\nLOTUS_BACKUP_BASE_PATH environment variable set to some path, and that\nthe path specified when calling CreateBackup is within the base path\n",
752752
"paramStructure": "by-position",
753753
"params": [
754754
{

documentation/en/api-v0-methods-miner.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -464,7 +464,7 @@ Response:
464464

465465

466466
### CreateBackup
467-
CreateBackup creates node backup onder the specified file name. The
467+
CreateBackup creates node backup under the specified file name. The
468468
method requires that the lotus-miner is running with the
469469
LOTUS_BACKUP_BASE_PATH environment variable set to some path, and that
470470
the path specified when calling CreateBackup is within the base path

documentation/en/api-v1-unstable-methods.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1268,7 +1268,7 @@ Parameters:
12681268
Returns:
12691269
- *types.IndexValidation: A pointer to an IndexValidation struct containing the results of the validation/backfill.
12701270
- error: An error object if the validation/backfill fails. The error message will contain details about the index
1271-
corruption if the call fails because of an incosistency between indexed data and the actual chain state.
1271+
corruption if the call fails because of an inconsistency between indexed data and the actual chain state.
12721272
Note: The API returns an error if the index does not have data for the specified epoch and backfill is set to false.
12731273

12741274

0 commit comments

Comments
 (0)