Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

v2.21.0 Documentation fixes #1158

Merged
merged 2 commits into from
Aug 10, 2023
Merged

Conversation

BorisDog
Copy link
Contributor

@BorisDog BorisDog commented Aug 9, 2023

No description provided.

@BorisDog BorisDog requested a review from rstam August 9, 2023 23:57
@@ -120,7 +120,7 @@ public interface IMongoSearchIndexManager
/// <param name="aggregateOptions">The aggregate options.</param>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>
/// A Task whose result is a cursor.
/// A task whose result is a cursor.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Task with a capital T is a class name.

public IBsonSerializer<TDerived> DerivedSerializer => _derivedSerializer;

/// <inheritdoc/>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is an explicitly implemented interface property and therefore private. Why does it even need <inheritdoc/>?

@@ -130,6 +130,7 @@ public interface IMongoSearchIndexManager
/// <param name="name">Name of the index.</param>
/// <param name="definition">The definition.</param>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>A task.</returns>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not true. Returns nothing.

@@ -138,6 +139,7 @@ public interface IMongoSearchIndexManager
/// <param name="name">Name of the index.</param>
/// <param name="definition">The definition.</param>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>A task.</returns>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Task with capital T.

@BorisDog BorisDog requested a review from rstam August 10, 2023 00:26
Copy link
Contributor

@rstam rstam left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@BorisDog BorisDog merged commit 5a9c331 into mongodb:master Aug 10, 2023
9 of 10 checks passed
@BorisDog BorisDog deleted the v2.21.0_docs_fix branch August 10, 2023 00:50
dnickless pushed a commit to dnickless/mongo-csharp-driver that referenced this pull request Aug 24, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants