docs: clarify IBlockApi.StatAsync

richardschneider · Mar 16, 2018 · 92557db · 92557db
1 parent a32e127
commit 92557db
Showing 1 changed file with 5 additions and 1 deletion.
diff --git a/src/CoreApi/IBlockApi.cs b/src/CoreApi/IBlockApi.cs
@@ -112,8 +112,12 @@ Task<Cid> PutAsync(
         /// </param>
         /// <returns>
         ///    A task that represents the asynchronous operation. The task's value
-        ///    contains the block's id and size.
+        ///    contains the block's id and size or <b>null</b>.
         /// </returns>
+        /// <remarks>
+        ///   Only the local repository is consulted for the block.  If <paramref name="id"/>
+        ///   does not exist, then <b>null</b> is retuned.
+        /// </remarks>
         Task<IDataBlock> StatAsync(Cid id, CancellationToken cancel = default(CancellationToken));
 
         /// <summary>