[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:
Related
is related to CDRIVER-2925 Support 'startAfter' option to the $c... Closed

 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 CDRIVER-2925.



 Comments   
Comment by Githook User [ 21/Feb/20 ]

Author:

{'name': 'Kevin Albertson', 'username': 'kevinAlbs', 'email': 'kevin.albertson@mongodb.com'}

Message: CDRIVER-3017 add disclaimer to opts files
Branch: master
https://github.com/mongodb/mongo-c-driver/commit/958fb6f084554f71abc2affa0987c704717e7bef

Generated at Wed Feb 07 21:16:56 UTC 2024 using Jira 9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66.