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]>
filecoin-project · Feb 17, 2025 · 04a5f33 · 04a5f33
1 parent 97dc186
commit 04a5f33
Show file tree

Hide file tree

Showing 6 changed files with 6 additions and 6 deletions.
diff --git a/api/api_full.go b/api/api_full.go
@@ -90,7 +90,7 @@ type FullNode interface {
 	// Returns:
 	//   - *types.IndexValidation: A pointer to an IndexValidation struct containing the results of the validation/backfill.
 	//   - error: An error object if the validation/backfill fails. The error message will contain details about the index
-	//            corruption if the call fails because of an incosistency between indexed data and the actual chain state.
+	//            corruption if the call fails because of an inconsistency between indexed data and the actual chain state.
 	//            Note: The API returns an error if the index does not have data for the specified epoch and backfill is set to false.
 	ChainValidateIndex(ctx context.Context, epoch abi.ChainEpoch, backfill bool) (*types.IndexValidation, error) //perm:write
 

diff --git a/api/api_storage.go b/api/api_storage.go
@@ -215,7 +215,7 @@ type StorageMiner interface {
 	// in this instance.
 	RuntimeSubsystems(ctx context.Context) (MinerSubsystems, error) //perm:read
 
-	// CreateBackup creates node backup onder the specified file name. The
+	// CreateBackup creates node backup under the specified file name. The
 	// method requires that the lotus-miner is running with the
 	// LOTUS_BACKUP_BASE_PATH environment variable set to some path, and that
 	// the path specified when calling CreateBackup is within the base path

diff --git a/build/openrpc/full.json b/build/openrpc/full.json
@@ -2012,7 +2012,7 @@
         {
             "name": "Filecoin.ChainValidateIndex",
             "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```",
-            "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",
+            "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",
             "paramStructure": "by-position",
             "params": [
                 {

diff --git a/build/openrpc/miner.json b/build/openrpc/miner.json
@@ -748,7 +748,7 @@
         {
             "name": "Filecoin.CreateBackup",
             "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```",
-            "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",
+            "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",
             "paramStructure": "by-position",
             "params": [
                 {

diff --git a/documentation/en/api-v0-methods-miner.md b/documentation/en/api-v0-methods-miner.md
@@ -464,7 +464,7 @@ Response:
 
 
 ### CreateBackup
-CreateBackup creates node backup onder the specified file name. The
+CreateBackup creates node backup under the specified file name. The
 method requires that the lotus-miner is running with the
 LOTUS_BACKUP_BASE_PATH environment variable set to some path, and that
 the path specified when calling CreateBackup is within the base path

diff --git a/documentation/en/api-v1-unstable-methods.md b/documentation/en/api-v1-unstable-methods.md
@@ -1268,7 +1268,7 @@ Parameters:
 Returns:
   - *types.IndexValidation: A pointer to an IndexValidation struct containing the results of the validation/backfill.
   - error: An error object if the validation/backfill fails. The error message will contain details about the index
-           corruption if the call fails because of an incosistency between indexed data and the actual chain state.
+           corruption if the call fails because of an inconsistency between indexed data and the actual chain state.
            Note: The API returns an error if the index does not have data for the specified epoch and backfill is set to false.