RPC/GetBlockTime: more comments

rpc/getBlockTime.go

@@ -4,6 +4,7 @@ import (
 	"context"
 )
 
+// Estimated production time, as Unix timestamp (seconds since the Unix epoch)
 type GetBlockTimeResult int64
 
 // GetBlockTime returns the estimated production time of a block.
@@ -12,6 +13,10 @@ type GetBlockTimeResult int64
 // particular block. A requested block's time is calculated from
 // the stake-weighted mean of the Vote timestamps in a set of
 // recent blocks recorded on the ledger.
+//
+// The result will be an int64 estimated production time,
+// as Unix timestamp (seconds since the Unix epoch),
+// or nil if the timestamp is not available for this block.
 func (cl *Client) GetBlockTime(
 	ctx context.Context,
 	block uint64, // block, identified by Slot