Doc includes made by generate-opts.py should indicate that they were generated

XMLWordPrintableJSON

    • Type: Improvement
    • Resolution: Fixed
    • Priority: Minor - P4
    • 1.17.0-beta, 1.17.0
    • Affects Version/s: None
    • Component/s: Docs, libmongoc
    • None
    • None
    • None
    • None
    • None
    • None
    • None
    • None

      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.

            Assignee:
            Unassigned
            Reporter:
            Jeremy Mikola
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

              Created:
              Updated:
              Resolved: