CDRIVER-4363 document mongoc_bulkwrite_t
#1602
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
It will be reused for the `comment` option
Matches the spec, and existing C driver representation of `comment` for other functions.
and add blurb comparing bulk write types
rcsanchez97
approved these changes
May 16, 2024
Co-authored-by: Roberto C. Sánchez <[email protected]>
Co-authored-by: Roberto C. Sánchez <[email protected]>
kkloberdanz
approved these changes
May 17, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Add API documentation for
mongoc_bulkwrite_tand related API introduced in #1590Change the
commenttype tobson_value_t *.As a drive-by improvement,
sphinx-autobuildis mentioned in CONTRIBUTING.md as a convenient alternative to serving docs locally.Background & Motivation
Descriptionsections were mostly modeled from the API comments in the spec.The type of
commentinmongoc_bulkwriteopts_set_commentwas incorrectly abson_t *(a BSON document). It is changed tobson_value_t *(any BSON value) to better match the spec's BulkWriteOptions.comment. This follows existing C driver patterns. Example:commentis represented asbson_value_t *in mongoc_collection_aggregate.Rendered docs can be viewed from the
Filestab of thismake-docstask here