[GODRIVER-581] Add documentation for new bsoncodec package Created: 27/Sep/18  Updated: 12/Dec/18  Resolved: 12/Dec/18

Status: Closed
Project: Go Driver
Component/s: Documentation
Affects Version/s: None
Fix Version/s: 0.2.0

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

Issue Links:
Depends
depends on GODRIVER-494 BSON Codec Redesign Closed
Epic Link: GoDocs for 1.0

 Description   

The bsoncodec package is currently under documented. It has no package documentation, no examples, and the documentation for types is sparse. Fully document the package, including the following:

  1. Add package level documentation explaining how the package works and how to get started.
  2. Document the major types and add examples for how to use them. The examples should use Go test's Example* style functions.


 Comments   
Comment by Githook User [ 12/Dec/18 ]

Author:

{'name': 'Kris Brandow', 'email': 'kris@mongodb.com', 'username': 'skriptble'}

Message: Add documentation to the bsoncodec package

GODRIVER-581

Change-Id: Ie1869877f25b5596fdabaf5b55d7a7081b237f48
Branch: master
https://github.com/mongodb/mongo-go-driver/commit/168c64dcadca69529a06a09948db1df49be75a40

Comment by Kristofer Brandow (Inactive) [ 07/Dec/18 ]

Code Review: https://review.gerrithub.io/c/mongodb/mongo-go-driver/+/436525.

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