[DOCS-9160] Comment on: "manual/reference/method/db.collection.remove.txt" Created: 18/Oct/16  Updated: 19/Oct/16  Resolved: 19/Oct/16

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

Type: Bug Priority: Trivial - P5
Reporter: Docs Collector User (Inactive) Assignee: Allison Reinheimer Moore
Resolution: Done Votes: 0
Labels: bite-sized, collector-298ba4e7
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified
Environment:

Location: https://docs.mongodb.com/v3.2/reference/method/db.collection.remove/#writeresults-remove
User-Agent: Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/54.0.2840.59 Safari/537.36
Referrer: https://docs.mongodb.com/v3.2/tutorial/remove-documents/
Screen Resolution: 1440 x 900


Participants:
Days since reply: 7 years, 17 weeks, 1 day ago
Story Points: 0.25

 Description   

I found an inconsistency in your documentation about writeConcernError field.
In this section: https://docs.mongodb.com/v3.2/reference/method/db.collection.remove/#write-concern-errors ; It says that the writeResult object has this shape:

WriteResult({
   "nRemoved" : 21,
   "writeConcernError" : {
      "code" : 64,
      "errInfo" : {
         "wtimeout" : true
      },
      "errmsg" : "waiting for replication timed out"
   }
})

Saying that errmsg is in WriteResult.errmsg.

However, in the writeConcern error page:
https://docs.mongodb.com/v3.2/reference/method/WriteResult/#WriteResult.writeConcernError ; It says that errmsg for writeConcern is in WriteResult.writeConcernError.errmsg



 Comments   
Comment by Allison Reinheimer Moore [ 19/Oct/16 ]

In the writeResult object that you quoted, errInfo is nested under writeConcernError, which is consistent with the explanation on the Write Result method page – writeResult.writeConcernError.errInfo. I suspect that the nesting of the documents made this harder to parse.

I don't see any spots where we've shown errInfo to be directly under the writeResult object, but if I've missed something, please let us know!

Thanks!

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