docsgen: Add []abi.SectorNumber example

filecoin-project · Dec 10, 2020 · 4734690 · 4734690
1 parent 564b88a
commit 4734690
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 2 deletions.
diff --git a/api/docgen/docgen.go b/api/docgen/docgen.go
@@ -240,6 +240,7 @@ func init() {
 	addExample(map[api.SectorState]int{
 		api.SectorState(sealing.Proving): 120,
 	})
+	addExample([]abi.SectorNumber{123, 124})
 
 	// worker specific
 	addExample(storiface.AcquireMove)

diff --git a/documentation/en/api-methods-miner.md b/documentation/en/api-methods-miner.md
@@ -1496,7 +1496,13 @@ Perms: read
 
 Inputs: `null`
 
-Response: `null`
+Response:
+```json
+[
+  123,
+  124
+]
+```
 
 ### SectorsListInStates
 List sectors in particular states
@@ -1511,7 +1517,13 @@ Inputs:
 ]
 ```
 
-Response: `null`
+Response:
+```json
+[
+  123,
+  124
+]
+```
 
 ### SectorsRefs
 There are not yet any comments for this method.