Merge pull request #3947 from greymistcube/chore/cleanup

🧹 📝 Minor docs change

CHANGES.md

@@ -62,10 +62,10 @@ Version 5.2.2
 
 Released on August 8, 2024.
 
- - Ported changes from [Libplanet 5.2.2] release.  [[#3915]]
+ - (Libplanet.Explorer) Fix an issue with high CPU usage
+   when querying blocks [[#3897]]
 
-[#3915]: https://github.com/planetarium/libplanet/pull/3915
-[Libplanet 5.2.2]: https://www.nuget.org/packages/Libplanet/5.2.2
+[#3897]: https://github.com/planetarium/libplanet/pull/3897
 
 
 Version 5.2.1

src/Libplanet.Net/Swarm.cs

@@ -808,6 +808,24 @@ internal async Task<List<BlockHash>> GetBlockHashes(
             }
         }
 
+        /// <summary>
+        /// Download <see cref="Block"/>s corresponding to <paramref name="blockHashes"/>
+        /// from <paramref name="peer"/>.
+        /// </summary>
+        /// <param name="peer">A <see cref="BoundPeer"/> to request <see cref="Block"/>s from.
+        /// </param>
+        /// <param name="blockHashes">A <see cref="List{T}"/> of <see cref="BlockHash"/>es
+        /// of <see cref="Block"/>s to be downloaded from <paramref name="peer"/>.</param>
+        /// <param name="cancellationToken">A cancellation token used to propagate notification
+        /// that this operation should be canceled.</param>
+        /// <returns>An <see cref="IAsyncEnumerable{T}"/> of <see cref="Block"/> and
+        /// <see cref="BlockCommit"/> pairs corresponding to <paramref name="blockHashes"/>.
+        /// Returned <see cref="Block"/>s are guaranteed to correspond to the initial part of
+        /// <paramref name="blockHashes"/>, including the empty list and the full list in order.
+        /// </returns>
+        /// <exception cref="InvalidMessageContentException">Thrown when
+        /// a message other than <see cref="BlocksMsg"/> is received while
+        /// trying to get <see cref="Block"/>s from <paramref name="peer"/>.</exception>
         internal async IAsyncEnumerable<(Block, BlockCommit)> GetBlocksAsync(
             BoundPeer peer,
             List<BlockHash> blockHashes,