[DOCS-2884] Ambiguous sentences on Single Field Indexes page Created: 10/Mar/14  Updated: 25/Mar/14  Resolved: 25/Mar/14

Status: Closed
Project: Documentation
Component/s: manual
Affects Version/s: None
Fix Version/s: v1.3.3

Type: Bug Priority: Minor - P4
Reporter: Kamran K. Assignee: Sam Kleinman (Inactive)
Resolution: Done Votes: 0
Labels: audit-2014
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
Related
Participants:
Days since reply: 9 years, 47 weeks, 1 day ago

 Description   

There are two sentences on http://docs.mongodb.org/manual/core/index-single/ that could use clarification or rewording:

1 - "MongoDB supports indexes that contain either a single field or multiple fields depending on the operations that index supports."

--> This sentence is a bit unclear because it's using 'index' to refer to index types and individual indexes. Perhaps it should say 'depending on the operations that index type supports' or something similar?

2 - "Think of the _id field as the primary key for a collection. Every document must have a unique _id field. You may store any unique value in the _id field. The default value of _id is an ObjectID on every insert() operation. An ObjectId is a 12-byte unique identifiers suitable for use as the value of an _id field."

--> This sentence is hard to parse. It's also a bit misleading because save() can automatically generate an ObjectId, as well.



 Comments   
Comment by Githook User [ 25/Mar/14 ]

Author:

{u'username': u'tychoish', u'name': u'Sam Kleinman', u'email': u'samk@10gen.com'}

Message: DOCS-2884: clarifications to difficult sentences about single field indexes
Branch: v2.4
https://github.com/mongodb/docs/commit/e730f57f6957df56ea462d55c105e726321515b3

Comment by Githook User [ 25/Mar/14 ]

Author:

{u'username': u'tychoish', u'name': u'Sam Kleinman', u'email': u'samk@10gen.com'}

Message: DOCS-2884: clarifications to difficult sentences about single field indexes
Branch: master
https://github.com/mongodb/docs/commit/fae52fea006272c820a50bee2535ee2f67ed3bcc

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