[CXX-2582] Docs: Tutorial Improvement Suggestions Created: 27/Sep/22 Updated: 07/Feb/24 Resolved: 13/Mar/23 |
|
| Status: | Closed |
| Project: | C++ Driver |
| Component/s: | Documentation |
| Affects Version/s: | None |
| Fix Version/s: | 3.7.1 |
| Type: | Task | Priority: | Unknown |
| Reporter: | Steve Silvester | Assignee: | Kevin Albertson |
| Resolution: | Fixed | Votes: | 0 |
| Labels: | buildfest-2022 | ||
| Remaining Estimate: | Not Specified | ||
| Time Spent: | Not Specified | ||
| Original Estimate: | Not Specified | ||
| Quarter: | FY24Q1 |
| Description |
|
Re: https://mongocxx.org/mongocxx-v3/tutorial/ "You can obtain this value using the inserted_ids() method of the returned mongocxx::result::insert_many instance" - It would be helpful to give an example here. In the "Access a Collection" section, we should use the variable name collection, since that is used for the rest of the tutorial. Ideally the names of the results would all be unique, such as delete_result, so you do not have to rename them yourself to prevent collisions. These changes would make it easier to follow along by copy/pasting and running the code incrementally. |
| Comments |
| Comment by Githook User [ 14/Mar/23 ] |
|
Author: {'name': 'Kevin Albertson', 'email': 'kevin.albertson@mongodb.com', 'username': 'kevinAlbs'}Message:
It is not output by pkg-config for libmongocxx and is not necessary for an application
The invalid JSON values are rendered highlighted in black.
Fixes `error: no member named 'to_string' in 'std::string_view'`
This is requested in the ticket.
Use of the stream builder is documented as discouraged.
To shorten the output
To fix `-Wunused-variable` warnings
This is the default behavior unless overridden with an unacknowledged write concern.
C++ driver 3.7.0 depends on C driver 1.22.1.
To further simplify example.
Release builds may undefine the assert macro and result
Co-authored-by: Roberto C. Sánchez <roberto@connexer.com> --------- Co-authored-by: Roberto C. Sánchez <roberto@connexer.com> |
| Comment by Githook User [ 13/Mar/23 ] |
|
Author: {'name': 'Kevin Albertson', 'email': 'kevin.albertson@mongodb.com', 'username': 'kevinAlbs'}Message:
It is not output by pkg-config for libmongocxx and is not necessary for an application
The invalid JSON values are rendered highlighted in black.
Fixes `error: no member named 'to_string' in 'std::string_view'`
This is requested in the ticket.
Use of the stream builder is documented as discouraged.
To shorten the output
To fix `-Wunused-variable` warnings
This is the default behavior unless overridden with an unacknowledged write concern.
C++ driver 3.7.0 depends on C driver 1.22.1.
To further simplify example.
Release builds may undefine the assert macro and result
Co-authored-by: Roberto C. Sánchez <roberto@connexer.com> --------- Co-authored-by: Roberto C. Sánchez <roberto@connexer.com> |
| Comment by Githook User [ 13/Mar/23 ] |
|
Author: {'name': 'Kevin Albertson', 'email': 'kevin.albertson@mongodb.com', 'username': 'kevinAlbs'}Message:
It is not output by pkg-config for libmongocxx and is not necessary for an application
The invalid JSON values are rendered highlighted in black.
Fixes `error: no member named 'to_string' in 'std::string_view'`
This is requested in the ticket.
Use of the stream builder is documented as discouraged.
To shorten the output
To fix `-Wunused-variable` warnings
This is the default behavior unless overridden with an unacknowledged write concern.
C++ driver 3.7.0 depends on C driver 1.22.1.
To further simplify example.
Release builds may undefine the assert macro and result
Co-authored-by: Roberto C. Sánchez <roberto@connexer.com> --------- Co-authored-by: Roberto C. Sánchez <roberto@connexer.com> |