[DOCS-13645] Update to MongoDb specification regarding coefficient encoding in BSON decimal Created: 12/May/20  Updated: 30/Jun/20  Resolved: 15/May/20

Status: Closed
Project: Documentation
Component/s: bsonspec
Affects Version/s: 3.6 Required, currentVersion, 4.0 Required, 3.4 Required
Fix Version/s: None

Type: Bug Priority: Minor - P4
Reporter: John Dupuy Assignee: Unassigned
Resolution: Done Votes: 0
Labels: spec
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
Related
related to DRIVERS-1313 Add coefficient encoding detail to De... Closed
Participants:
Days since reply: 3 years, 38 weeks, 5 days ago

 Description   

Description

At the repo: 

https://github.com/mongodb/specifications

At page:

https://github.com/mongodb/specifications/blob/master/source/bson-decimal128/decimal128.rst

The specification declares that the decimal function for MongoDB implements the http://speleotrove.com/decimal/decbits.html specification. However, that specification explicitly declares that the coefficient is encoded using Densely Packed Decimal (DPD) while the actual drivers encode using Binary Integer Decimal. This has caused at least two driver authors to originally write the wrong code. The error is easily addressed with a few minor changes in text.

 

I have a pending PR for this: https://github.com/mongodb/specifications/pull/795. Further details are in the PR.

 

I have notice that PRs with a declared issue in Jira get reviewed and possibly merged, so I'm adding this issue to help this out.

Scope of changes

Impact to Other Docs

MVP (Work and Date)

Resources (Scope or Design Docs, Invision, etc.)



 Comments   
Comment by Kay Kim (Inactive) [ 15/May/20 ]

Heh - none of the Resolutions available in the DOCS ticket is relevant. Will select Community Answered as a stand-in.

Comment by Kay Kim (Inactive) [ 15/May/20 ]

reopening - to update Resolution

Comment by Kay Kim (Inactive) [ 15/May/20 ]

Hi John - Thanks for not only doing the pull request but filing the ticket. Much appreciate your efforts to improve the specifications.

The DOCS project is actually for the pages shown on docs.mongodb.com. The specifications are managed by a separate team. I have let them know about your pull request and will close this DOCS ticket.

Regards,

Kay Kim

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