[GODRIVER-489] Provide basic documentation Created: 12/Jul/18  Updated: 19/Nov/18  Resolved: 05/Nov/18

Status: Closed
Project: Go Driver
Component/s: Core API
Affects Version/s: None
Fix Version/s: No Release

Type: Task Priority: Major - P3
Reporter: Mihai B Assignee: Kristofer Brandow (Inactive)
Resolution: Done Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified


 Description   

Provide minimal documentation. Figuring out how to use the package (i.e. how to build queries using various filters, sort, $group etc) is impossible unless you spend hours scanning the source code and test files.

The API/package is one of the worst designed Go packages/API I've seen(usability wise). 



 Comments   
Comment by Kristofer Brandow (Inactive) [ 05/Nov/18 ]

Closing due to lack of activity.

Comment by Kristofer Brandow (Inactive) [ 10/Sep/18 ]

Hi Mihai,

Sorry for the long delay in responding to this ticket. We currently have documentation on godoc. Additionally, there is MongoDB specific documentation available in the MongoDB Manual. When the Go driver becomes generally available there will be additional documentation added to the MongoDB Manual for the Go driver.

With respect to the API design, can you please give some examples of the parts of the API you find poorly designed and unusable?

Thanks,
Kris

Comment by jeyanthi [ 26/Jul/18 ]

Yup Definitely this is needed +1

Generated at Thu Feb 08 08:34:19 UTC 2024 using Jira 9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66.