[CDRIVER-2690] Should we factor code out of tutorial.rst? Created: 07/Jun/18 Updated: 09/Feb/23 |
|
| Status: | Backlog |
| Project: | C Driver |
| Component/s: | docs, Docs Examples, libmongoc |
| Affects Version/s: | None |
| Fix Version/s: | None |
| Type: | Improvement | Priority: | Minor - P4 |
| Reporter: | Kevin Albertson | Assignee: | Unassigned |
| Resolution: | Unresolved | Votes: | 0 |
| Labels: | None | ||
| Remaining Estimate: | Not Specified | ||
| Time Spent: | Not Specified | ||
| Original Estimate: | Not Specified | ||
| Description |
|
evgeni.dobranov noticed that the update example under "Updating a Document" in the mongoc tutorial.rst differs from the example-update.c included in the examples. Most of the code in tutorial.rst are fully compilable snippets. Should we extract them and place them into separate .c files under examples, and include with literal-include? |
| Comments |
| Comment by A. Jesse Jiryu Davis [ 08/Jun/18 ] |
|
Yes, let's factor example code, ensure it all compiles continuously and uses modern APIs. Examples are users' main introduction to the best way to use the driver. |