Skip to content

[C++] Add documentation warning against the use of duplicate key names #101

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jan 23, 2025
Merged

[C++] Add documentation warning against the use of duplicate key names #101

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c704c69
add note about duplicate keys
rachel-mack Jan 22, 2025
89d6448
move note
rachel-mack Jan 22, 2025
93d74ac
MW feedback
rachel-mack Jan 22, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions source/data-formats/working-with-bson.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,13 @@
values, and binary data. For a complete list of supported types, see the :manual:`BSON Types </reference/bson-types/>`
page in the {+mdb-server+} manual.

.. note::

Although the `BSON specification <https://bsonspec.org/>`__ allows BSON
documents to have duplicate keys, you should avoid doing this. The MongoDB

Check failure on line 34 in source/data-formats/working-with-bson.txt

View workflow job for this annotation

GitHub Actions / TDBX Vale rules 

[vale] reported by reviewdog 🐶
[MongoDB.AvoidSubjunctive] Avoid the subjunctive 'should'.

Raw Output:
{"message": "[MongoDB.AvoidSubjunctive] Avoid the subjunctive 'should'.", "location": {"path": "source/data-formats/working-with-bson.txt", "range": {"start": {"line": 34, "column": 42}}}, "severity": "ERROR"}
server behavior is undefined when a BSON document contains duplicate keys,
which can result in unexpected behavior.

BSON Values and Views
~~~~~~~~~~~~~~~~~~~~~

Expand Down
Loading