[DOCS-8343] $comment is not well documented Created: 13/Jul/16  Updated: 11/Jan/17  Resolved: 15/Jul/16

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

Type: Bug Priority: Major - P3
Reporter: Bernie Hackett Assignee: Unassigned
Resolution: Cannot Reproduce Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
Related
is related to DOCS-5986 Remove documentation of shell's wrapp... Closed
Participants:
Days since reply: 7 years, 30 weeks, 5 days ago

 Description   

The 3.2 docs claim that $comment is deprecated, I suspect because the find command has a "comment" option, rather than accepting $ operators:

https://docs.mongodb.com/manual/reference/operator/meta/comment/

But $comment is used more places than just find(). $comment can be used in any command that accepts query criteria (update, delete, findAndModify, aggregate, etc.). How to use $comment with these operations appears to be completely undocumented.



 Comments   
Comment by Bernie Hackett [ 15/Jul/16 ]

Interesting. An example of how to use it with update() or delete() would also be useful.

Comment by Kay Kim (Inactive) [ 15/Jul/16 ]

Turns out we document that $comment operator at https://docs.mongodb.com/manual/reference/operator/query/comment/

Rediscovered it as I'm putting back the $meta operators which had a disambiguation statement regarding the other comment.

Comment by Bernie Hackett [ 13/Jul/16 ]

Perhaps this information should be added to the docs here:

https://docs.mongodb.com/manual/tutorial/manage-the-database-profiler/

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