CSHARP-2310: Add API-level documentation for restriction of geo commands in count helpers.

Author: rstam

src/MongoDB.Driver/IFindFluent.cs

@@ -68,13 +68,43 @@ public interface IFindFluent<TDocument, TProjection> : IAsyncCursorSource<TProje
         /// <summary>
         /// Counts the number of documents.
         /// </summary>
+        /// <remarks>
+        /// Note: when migrating from Count to CountDocuments the following query operations must be replaced:
+        /// 
+        /// <code>
+        /// +-------------+--------------------------------+
+        /// | Operator    | Replacement                    |
+        /// +=============+================================+
+        /// | $where      |  $expr                         |
+        /// +-------------+--------------------------------+
+        /// | $near       |  $geoWithin with $center       |
+        /// +-------------+--------------------------------+
+        /// | $nearSphere |  $geoWithin with $centerSphere |
+        /// +-------------+--------------------------------+
+        /// </code>
+        /// </remarks>
         /// <param name="cancellationToken">The cancellation token.</param>
         /// <returns>The count.</returns>
         long CountDocuments(CancellationToken cancellationToken = default(CancellationToken));
 
         /// <summary>
         /// Counts the number of documents.
         /// </summary>
+        /// <remarks>
+        /// Note: when migrating from CountAsync to CountDocumentsAsync the following query operations must be replaced:
+        /// 
+        /// <code>
+        /// +-------------+--------------------------------+
+        /// | Operator    | Replacement                    |
+        /// +=============+================================+
+        /// | $where      |  $expr                         |
+        /// +-------------+--------------------------------+
+        /// | $near       |  $geoWithin with $center       |
+        /// +-------------+--------------------------------+
+        /// | $nearSphere |  $geoWithin with $centerSphere |
+        /// +-------------+--------------------------------+
+        /// </code>
+        /// </remarks>
         /// <param name="cancellationToken">The cancellation token.</param>
         /// <returns>A Task whose result is the count.</returns>
         Task<long> CountDocumentsAsync(CancellationToken cancellationToken = default(CancellationToken));

src/MongoDB.Driver/IMongoCollection.cs

@@ -198,6 +198,21 @@ public interface IMongoCollection<TDocument>
         /// <summary>
         /// Counts the number of documents in the collection.
         /// </summary>
+        /// <remarks>
+        /// Note: when migrating from Count to CountDocuments the following query operations must be replaced:
+        /// 
+        /// <code>
+        /// +-------------+--------------------------------+
+        /// | Operator    | Replacement                    |
+        /// +=============+================================+
+        /// | $where      |  $expr                         |
+        /// +-------------+--------------------------------+
+        /// | $near       |  $geoWithin with $center       |
+        /// +-------------+--------------------------------+
+        /// | $nearSphere |  $geoWithin with $centerSphere |
+        /// +-------------+--------------------------------+
+        /// </code>
+        /// </remarks>
         /// <param name="filter">The filter.</param>
         /// <param name="options">The options.</param>
         /// <param name="cancellationToken">The cancellation token.</param>
@@ -209,6 +224,21 @@ public interface IMongoCollection<TDocument>
         /// <summary>
         /// Counts the number of documents in the collection.
         /// </summary>
+        /// <remarks>
+        /// Note: when migrating from Count to CountDocuments the following query operations must be replaced:
+        /// 
+        /// <code>
+        /// +-------------+--------------------------------+
+        /// | Operator    | Replacement                    |
+        /// +=============+================================+
+        /// | $where      |  $expr                         |
+        /// +-------------+--------------------------------+
+        /// | $near       |  $geoWithin with $center       |
+        /// +-------------+--------------------------------+
+        /// | $nearSphere |  $geoWithin with $centerSphere |
+        /// +-------------+--------------------------------+
+        /// </code>
+        /// </remarks>
         /// <param name="session">The session.</param>
         /// <param name="filter">The filter.</param>
         /// <param name="options">The options.</param>
@@ -221,6 +251,21 @@ public interface IMongoCollection<TDocument>
         /// <summary>
         /// Counts the number of documents in the collection.
         /// </summary>
+        /// <remarks>
+        /// Note: when migrating from CountAsync to CountDocumentsAsync the following query operations must be replaced:
+        /// 
+        /// <code>
+        /// +-------------+--------------------------------+
+        /// | Operator    | Replacement                    |
+        /// +=============+================================+
+        /// | $where      |  $expr                         |
+        /// +-------------+--------------------------------+
+        /// | $near       |  $geoWithin with $center       |
+        /// +-------------+--------------------------------+
+        /// | $nearSphere |  $geoWithin with $centerSphere |
+        /// +-------------+--------------------------------+
+        /// </code>
+        /// </remarks>
         /// <param name="filter">The filter.</param>
         /// <param name="options">The options.</param>
         /// <param name="cancellationToken">The cancellation token.</param>
@@ -232,6 +277,21 @@ public interface IMongoCollection<TDocument>
         /// <summary>
         /// Counts the number of documents in the collection.
         /// </summary>
+        /// <remarks>
+        /// Note: when migrating from CountAsync to CountDocumentsAsync the following query operations must be replaced:
+        /// 
+        /// <code>
+        /// +-------------+--------------------------------+
+        /// | Operator    | Replacement                    |
+        /// +=============+================================+
+        /// | $where      |  $expr                         |
+        /// +-------------+--------------------------------+
+        /// | $near       |  $geoWithin with $center       |
+        /// +-------------+--------------------------------+
+        /// | $nearSphere |  $geoWithin with $centerSphere |
+        /// +-------------+--------------------------------+
+        /// </code>
+        /// </remarks>
         /// <param name="session">The session.</param>
         /// <param name="filter">The filter.</param>
         /// <param name="options">The options.</param>