[CDRIVER-3017] Doc includes made by generate-opts.py should indicate that they were generated Created: 14/Mar/19 Updated: 28/Oct/23 Resolved: 21/Feb/20 |
|
| Status: | Closed |
| Project: | C Driver |
| Component/s: | docs, libmongoc |
| Affects Version/s: | None |
| Fix Version/s: | 1.17.0-beta, 1.17.0 |
| Type: | Improvement | Priority: | Minor - P4 |
| Reporter: | Jeremy Mikola | Assignee: | Unassigned |
| Resolution: | Fixed | Votes: | 0 |
| Labels: | None | ||
| Remaining Estimate: | Not Specified | ||
| Time Spent: | Not Specified | ||
| Original Estimate: | Not Specified | ||
| Issue Links: |
|
||||||||
| Description |
|
I noticed that generate-opts.py is able to produce include files for options structs. Unlike the generated mongoc-opts.c file, the doc includes do not receive a header to indicate that the files were automatically generated and should not be modified. It may be worth using an RST comment for this purpose. I came across this while adding the startAfter change stream option for |
| Comments |
| Comment by Githook User [ 21/Feb/20 ] |
|
Author: {'name': 'Kevin Albertson', 'username': 'kevinAlbs', 'email': 'kevin.albertson@mongodb.com'}Message: |