Uploaded image for project: 'C Driver'
  1. C Driver
  2. CDRIVER-3361

session_opts and transaction_opts clone method docs should discuss freeing the copy

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

      The documentation for mongoc_cursor_clone states that it returns a newly allocated struct that should be freed with a particular method (it links to mongoc_cursor_destroy. The docs for the session_opts and transaction_opts clone methods simply state that they create a copy of a struct in their "Synopsis" section. Those pages also don't have a "Returns" section as the cursor method does. I think they can be improved by 'd do well to link to the corresponding destroy method. Optionally, consider doing so in a "Returns" section for consistency.

      Related pages:

            Assignee:
            ezra.chung@mongodb.com Ezra Chung
            Reporter:
            jmikola@mongodb.com Jeremy Mikola
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

              Created:
              Updated:
              Resolved: