chore(docs): fix mismatched godoc method names (#12736)

Signed-off-by: thirdkeyword <[email protected]>
filecoin-project · Nov 28, 2024 · bb7e62d · bb7e62d
1 parent 07f2f69
commit bb7e62d
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
@@ -618,7 +618,7 @@ type FullNode interface {
 	// StateGetRandomnessFromBeacon is used to sample the beacon for randomness.
 	StateGetRandomnessFromBeacon(ctx context.Context, personalization crypto.DomainSeparationTag, randEpoch abi.ChainEpoch, entropy []byte, tsk types.TipSetKey) (abi.Randomness, error) //perm:read
 
-	// StateGetRandomnessDigestFromTickets. is used to sample the chain for randomness.
+	// StateGetRandomnessDigestFromTickets is used to sample the chain for randomness.
 	StateGetRandomnessDigestFromTickets(ctx context.Context, randEpoch abi.ChainEpoch, tsk types.TipSetKey) (abi.Randomness, error) //perm:read
 	// StateGetRandomnessDigestFromBeacon is used to sample the beacon for randomness.
 	StateGetRandomnessDigestFromBeacon(ctx context.Context, randEpoch abi.ChainEpoch, tsk types.TipSetKey) (abi.Randomness, error) //perm:read

diff --git a/api/api_storage.go b/api/api_storage.go
@@ -45,7 +45,7 @@ type StorageMiner interface {
 	ActorSectorSize(context.Context, address.Address) (abi.SectorSize, error) //perm:read
 	ActorAddressConfig(ctx context.Context) (AddressConfig, error)            //perm:read
 
-	// WithdrawBalance allows to withdraw balance from miner actor to owner address
+	// ActorWithdrawBalance allows to withdraw balance from miner actor to owner address
 	// Specify amount as "0" to withdraw full balance. This method returns a message CID
 	// and does not wait for message execution
 	ActorWithdrawBalance(ctx context.Context, amount abi.TokenAmount) (cid.Cid, error) //perm:admin

diff --git a/build/openrpc/full.json b/build/openrpc/full.json
@@ -20169,7 +20169,7 @@
         {
             "name": "Filecoin.StateGetRandomnessDigestFromTickets",
             "description": "```go\nfunc (s *FullNodeStruct) StateGetRandomnessDigestFromTickets(p0 context.Context, p1 abi.ChainEpoch, p2 types.TipSetKey) (abi.Randomness, error) {\n\tif s.Internal.StateGetRandomnessDigestFromTickets == nil {\n\t\treturn *new(abi.Randomness), ErrNotSupported\n\t}\n\treturn s.Internal.StateGetRandomnessDigestFromTickets(p0, p1, p2)\n}\n```",
-            "summary": "StateGetRandomnessDigestFromTickets. is used to sample the chain for randomness.\n",
+            "summary": "StateGetRandomnessDigestFromTickets is used to sample the chain for randomness.\n",
             "paramStructure": "by-position",
             "params": [
                 {

diff --git a/build/openrpc/miner.json b/build/openrpc/miner.json
@@ -161,7 +161,7 @@
         {
             "name": "Filecoin.ActorWithdrawBalance",
             "description": "```go\nfunc (s *StorageMinerStruct) ActorWithdrawBalance(p0 context.Context, p1 abi.TokenAmount) (cid.Cid, error) {\n\tif s.Internal.ActorWithdrawBalance == nil {\n\t\treturn *new(cid.Cid), ErrNotSupported\n\t}\n\treturn s.Internal.ActorWithdrawBalance(p0, p1)\n}\n```",
-            "summary": "WithdrawBalance allows to withdraw balance from miner actor to owner address\nSpecify amount as \"0\" to withdraw full balance. This method returns a message CID\nand does not wait for message execution\n",
+            "summary": "ActorWithdrawBalance allows to withdraw balance from miner actor to owner address\nSpecify amount as \"0\" to withdraw full balance. This method returns a message CID\nand does not wait for message execution\n",
             "paramStructure": "by-position",
             "params": [
                 {

diff --git a/documentation/en/api-v0-methods-miner.md b/documentation/en/api-v0-methods-miner.md
@@ -237,7 +237,7 @@ Inputs:
 Response: `34359738368`
 
 ### ActorWithdrawBalance
-WithdrawBalance allows to withdraw balance from miner actor to owner address
+ActorWithdrawBalance allows to withdraw balance from miner actor to owner address
 Specify amount as "0" to withdraw full balance. This method returns a message CID
 and does not wait for message execution
 

diff --git a/documentation/en/api-v1-unstable-methods.md b/documentation/en/api-v1-unstable-methods.md
@@ -6833,7 +6833,7 @@ Inputs:
 Response: `"Bw=="`
 
 ### StateGetRandomnessDigestFromTickets
-StateGetRandomnessDigestFromTickets. is used to sample the chain for randomness.
+StateGetRandomnessDigestFromTickets is used to sample the chain for randomness.
 
 
 Perms: read