Skip to content

Commit

Permalink
GODRIVER-852 Add documentation warning against the use of duplicate k…
Browse files Browse the repository at this point in the history
…ey names (#614)
  • Loading branch information
benjirewis authored and Benjamin Rewis committed Apr 16, 2021
1 parent 3525304 commit 692114e
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 0 deletions.
2 changes: 2 additions & 0 deletions bson/bson.go
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,8 @@ type Zeroer interface {
// D is an ordered representation of a BSON document. This type should be used when the order of the elements matters,
// such as MongoDB command documents. If the order of the elements does not matter, an M should be used instead.
//
// A D should not be constructed with duplicate key names, as that can cause undefined server behavior.
//
// Example usage:
//
// bson.D{{"foo", "bar"}, {"hello", "world"}, {"pi", 3.14159}}
Expand Down
2 changes: 2 additions & 0 deletions bson/doc.go
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,8 @@
// slice and M is a map. For more information about the use cases for these types, see the documentation on the type
// definitions.
//
// Note that a D should not be constructed with duplicate key names, as that can cause undefined server behavior.
//
// Example:
// bson.D{{"foo", "bar"}, {"hello", "world"}, {"pi", 3.14159}}
// bson.M{"foo": "bar", "hello": "world", "pi": 3.14159}
Expand Down

0 comments on commit 692114e

Please sign in to comment.