CXX-3294 Relocate all remaining Manual Doc Page examples into the examples directory #1407
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
kevinAlbs
reviewed
May 21, 2025
| @@ -457,20 +457,17 @@ TEST_CASE("Documentation Examples", "[change_stream]") { | |||
| }}; | |||
|
|
|||
| SECTION("Example 1") { | |||
There was a problem hiding this comment.
the code itself remains to preserve code coverage as part of the test suite.
Suggest removing the doc examples from tests to avoid going out-of-sync. I expect the main purpose is documentation rather than testing. And the examples are run on most Evergreen configurations.
kevinAlbs
approved these changes
May 21, 2025
Comment on lines
182
to
184
| mongocxx::client const conn{mongocxx::uri{}}; | ||
|
|
||
| auto const db = conn["documentation_examples"]; |
There was a problem hiding this comment.
Suggested change
| mongocxx::client const conn{mongocxx::uri{}}; | |
| auto const db = conn["documentation_examples"]; |
Unused.
Comment on lines
179
to
180
| for (auto const& example : examples) { | ||
| mongocxx::pool pool{mongocxx::uri{}}; |
There was a problem hiding this comment.
Suggested change
| for (auto const& example : examples) { | |
| mongocxx::pool pool{mongocxx::uri{}}; | |
| mongocxx::pool pool{mongocxx::uri{}}; | |
| for (auto const& example : examples) { |
Suggest creating pool outside of loop. Pool destruction signals and waits for monitoring threads to shut down. Timing cmake --build cmake-build --target run-examples-mongocxx-mongodb.com-change_streams_examples locally showed a decrease of 2.207s => 1.156s.
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.
Resolves CXX-3294. Followup to #1403, which broke downstream Manual Doc pages due to several example code blocks that still remained under the
testdirectory (these are identified by// (Start|Begin|End) <name>comments). All such remaining code blocks are copied into equivalent files under theexamples/mongocxx/mongodb.comdirectory for consistency and to inform future maintainers about their stability requirement by downstream Manual Doc pages. Although the comments under thetestdirectory are removed, the code itself remains to preserve code coverage as part of the test suite.Catch2 assertions such as
CHECK(cond)are converted intoif (!cond) { throw std::logic_error{...}; }for consistency with other example code. The rest of the code block contents and structure is otherwise preserved as much as possible with their prior form asSECTION()blocks.As a drive-by fix/improvement, the requirement that the replica set against which the examples are run is named
repl0(withreplicaSet=repl0) is removed. AFAIK no such expectation or requirement is necessary for example code.