[CDRIVER-1422] Ensure that experimental features are undocumented, or marked "experimental" Created: 27/Jul/16  Updated: 10/Aug/16  Resolved: 10/Aug/16

Status: Closed
Project: C Driver
Component/s: docs
Affects Version/s: 1.4.0
Fix Version/s: 1.4.0

Type: Task Priority: Minor - P4
Reporter: A. Jesse Jiryu Davis Assignee: Hannes Magnusson
Resolution: Done Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified


 Description   

Let's audit the new functions and features we've added in 1.4 that are not official until 1.5. When we release 1.4 these features should still be undocumented.

It's also fine, for the sake of simplicity, to include some of these features in the documentation but marked "not released, requires experimental features enabled at build time".



 Comments   
Comment by Hannes Magnusson [ 10/Aug/16 ]

https://github.com/mongodb/mongo-c-driver/commit/35af0c287c8ae447f3cd15eeb3810f7c095a889d

Reverted mongoc_collection_aggregate_with_write_concern

Comment by A. Jesse Jiryu Davis [ 10/Aug/16 ]

mongoc_collection_aggregate_with_write_concern should be deleted off the r1.4 branch, it wasn't working yet when we branched from master.

Comment by Hannes Magnusson [ 10/Aug/16 ]

https://github.com/mongodb/mongo-c-driver/commit/7f75616e8caed410bef626d2946baa004db4ae7a

Comment by Hannes Magnusson [ 10/Aug/16 ]

(no jira comment because the commit hook hasn't been updated yet)

Comment by A. Jesse Jiryu Davis [ 09/Aug/16 ]

Great let's delete these files off the r1.4 branch.

Comment by Hannes Magnusson [ 09/Aug/16 ]
  • doc/mongoc_read_prefs_get_max_staleness_ms.page
  • doc/mongoc_read_prefs_set_max_staleness_ms.page

These are the only things I currently see documented in r1.4 which is behind experimental flag.

Since these are active in master I think we can safely remove them from the r1.4 branch.

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