update docs

filecoin-project · May 31, 2023 · 4108592 · 4108592
1 parent dc9e7f1
commit 4108592
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 0 deletions.
diff --git a/actors/miner/src/ext.rs b/actors/miner/src/ext.rs
@@ -221,6 +221,8 @@ pub mod verifreg {
     #[derive(Clone, Debug, PartialEq, Eq, Serialize_tuple, Deserialize_tuple)]
     #[serde(transparent)]
     pub struct ClaimAllocationsReturn {
+        /// claim_results is parallel to ClaimAllocationsParams.allocations with failed allocations
+        /// being represented by claimed_space == BigInt::zero()
         pub claim_results: Vec<SectorAllocationClaimResult>,
     }
 }
diff --git a/actors/verifreg/src/types.rs b/actors/verifreg/src/types.rs
@@ -146,6 +146,8 @@ pub struct SectorAllocationClaimResult {
 #[derive(Clone, Debug, PartialEq, Eq, Serialize_tuple, Deserialize_tuple)]
 #[serde(transparent)]
 pub struct ClaimAllocationsReturn {
+    /// claim_results is parallel to ClaimAllocationsParams.allocations with failed allocations
+    /// being represented by claimed_space == BigInt::zero()
     pub claim_results: Vec<SectorAllocationClaimResult>,
 }