[CDRIVER-1519] Update C Driver Documentation: 3.4 Feature Collation Created: 02/Sep/16  Updated: 11/Nov/16  Resolved: 11/Nov/16

Status: Closed
Project: C Driver
Component/s: docs, libmongoc
Affects Version/s: None
Fix Version/s: 1.5.0

Type: Task Priority: Major - P3
Reporter: Kay Kim (Inactive) Assignee: A. Jesse Jiryu Davis
Resolution: Done Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Epic Link: 3.4: Collation support

 Description   

The docs team will be working on writing the documentation updates for node.js/ruby/java drivers. If you want to wait until those are done, you can then borrow the text from those and tweak the wording as appropriate for your driver and swap out examples.



 Comments   
Comment by Githook User [ 11/Nov/16 ]

Author:

{u'username': u'ajdavis', u'name': u'A. Jesse Jiryu Davis', u'email': u'jesse@mongodb.com'}

Message: CDRIVER-1519 update NEWS for collation
Branch: master
https://github.com/mongodb/mongo-c-driver/commit/b698499dd631648ff8d0d0583222122a4d9e14e2

Comment by A. Jesse Jiryu Davis [ 11/Nov/16 ]

Kay wrote me:

> This is what's currently available in Java –
http://mongodb.github.io/mongo-java-driver/3.4/whats-new/ although I'm planning on moving the examples out to other sections.
>
>So, basically, it's just the blurb that you support it and which methods support it since you have examples already.

Comment by A. Jesse Jiryu Davis [ 21/Oct/16 ]

kay.kim what ticket should we watch to know when the Official Docs Team collation prose is done?

Once we've seen that prose we'll decide whether / how to update the C Driver's collation docs and then close this ticket.

Currently we have this example code and not much more:

https://s3.amazonaws.com/mciuploads/mongo-c-driver/docs/latest/mongoc_client_read_command_with_opts.html
https://s3.amazonaws.com/mciuploads/mongo-c-driver/docs/latest/bulk.html#bulk-write-collation
https://s3.amazonaws.com/mciuploads/mongo-c-driver/docs/latest/mongoc_collection_count_with_opts.html
https://s3.amazonaws.com/mciuploads/mongo-c-driver/docs/latest/mongoc_collection_find_with_opts.html
https://s3.amazonaws.com/mciuploads/mongo-c-driver/docs/latest/mongoc_index_opt_t.html

Comment by Hannes Magnusson [ 18/Oct/16 ]

I'm not clear on what this ticket means. What exactly are we supposed to document?

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