Skip to content

Commit bb7e62d

Browse files
authored
chore(docs): fix mismatched godoc method names (#12736)
Signed-off-by: thirdkeyword <[email protected]>
1 parent 07f2f69 commit bb7e62d

File tree

6 files changed

+6
-6
lines changed

6 files changed

+6
-6
lines changed

api/api_full.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -618,7 +618,7 @@ type FullNode interface {
618618
// StateGetRandomnessFromBeacon is used to sample the beacon for randomness.
619619
StateGetRandomnessFromBeacon(ctx context.Context, personalization crypto.DomainSeparationTag, randEpoch abi.ChainEpoch, entropy []byte, tsk types.TipSetKey) (abi.Randomness, error) //perm:read
620620

621-
// StateGetRandomnessDigestFromTickets. is used to sample the chain for randomness.
621+
// StateGetRandomnessDigestFromTickets is used to sample the chain for randomness.
622622
StateGetRandomnessDigestFromTickets(ctx context.Context, randEpoch abi.ChainEpoch, tsk types.TipSetKey) (abi.Randomness, error) //perm:read
623623
// StateGetRandomnessDigestFromBeacon is used to sample the beacon for randomness.
624624
StateGetRandomnessDigestFromBeacon(ctx context.Context, randEpoch abi.ChainEpoch, tsk types.TipSetKey) (abi.Randomness, error) //perm:read

api/api_storage.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ type StorageMiner interface {
4545
ActorSectorSize(context.Context, address.Address) (abi.SectorSize, error) //perm:read
4646
ActorAddressConfig(ctx context.Context) (AddressConfig, error) //perm:read
4747

48-
// WithdrawBalance allows to withdraw balance from miner actor to owner address
48+
// ActorWithdrawBalance allows to withdraw balance from miner actor to owner address
4949
// Specify amount as "0" to withdraw full balance. This method returns a message CID
5050
// and does not wait for message execution
5151
ActorWithdrawBalance(ctx context.Context, amount abi.TokenAmount) (cid.Cid, error) //perm:admin

build/openrpc/full.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -20169,7 +20169,7 @@
2016920169
{
2017020170
"name": "Filecoin.StateGetRandomnessDigestFromTickets",
2017120171
"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```",
20172-
"summary": "StateGetRandomnessDigestFromTickets. is used to sample the chain for randomness.\n",
20172+
"summary": "StateGetRandomnessDigestFromTickets is used to sample the chain for randomness.\n",
2017320173
"paramStructure": "by-position",
2017420174
"params": [
2017520175
{

build/openrpc/miner.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -161,7 +161,7 @@
161161
{
162162
"name": "Filecoin.ActorWithdrawBalance",
163163
"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```",
164-
"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",
164+
"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",
165165
"paramStructure": "by-position",
166166
"params": [
167167
{

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -237,7 +237,7 @@ Inputs:
237237
Response: `34359738368`
238238

239239
### ActorWithdrawBalance
240-
WithdrawBalance allows to withdraw balance from miner actor to owner address
240+
ActorWithdrawBalance allows to withdraw balance from miner actor to owner address
241241
Specify amount as "0" to withdraw full balance. This method returns a message CID
242242
and does not wait for message execution
243243

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -6833,7 +6833,7 @@ Inputs:
68336833
Response: `"Bw=="`
68346834

68356835
### StateGetRandomnessDigestFromTickets
6836-
StateGetRandomnessDigestFromTickets. is used to sample the chain for randomness.
6836+
StateGetRandomnessDigestFromTickets is used to sample the chain for randomness.
68376837

68386838

68396839
Perms: read

0 commit comments

Comments
 (0)