[CDRIVER-2152] Docs mention internal type mongoc_stream_gridfs_t Created: 05/May/17  Updated: 28/Oct/23  Resolved: 20/Nov/17

Status: Closed
Project: C Driver
Component/s: docs, GridFS
Affects Version/s: None
Fix Version/s: 1.9.0

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


 Description   

This struct is declared in a C file, not a header, the docs shouldn't mention it. Also, the doc for mongoc_stream_gridfs_new claims it makes a mongoc_gridfs_file_t, then claims it makes a mongoc_stream_gridfs_t, but in fact it should say it makes a mongoc_stream_t.



 Comments   
Comment by Githook User [ 20/Nov/17 ]

Author:

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

Message: CDRIVER-2152 note: GridFS stream ignores timeout
Branch: master
https://github.com/mongodb/mongo-c-driver/commit/2b778c6363120c4269e54a82293c9bcae15b1f15

Comment by Githook User [ 20/Nov/17 ]

Author:

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

Message: CDRIVER-2152 mistakes in GridFS file docs
Branch: master
https://github.com/mongodb/mongo-c-driver/commit/354f3be78c0af1de4aea095fbc6a9d630e71dd95

Comment by A. Jesse Jiryu Davis [ 05/May/17 ]

While fixing, also update mongoc_stream_gridfs_new doc to mention that the returned stream ignores timeouts when reading and writing.

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