[DOCS-2738] Changes to cursor.sort page Created: 18/Feb/14  Updated: 18/Mar/14  Resolved: 18/Mar/14

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

Type: Task Priority: Major - P3
Reporter: David Hows Assignee: Kay Kim (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, 48 weeks, 1 day ago

 Description   

Suggested changes to page http://docs.mongodb.org/master/reference/method/cursor.sort/

  • Provide examples which show how sort affects results, eg an unsorted output vs a sorted output.
  • Provide examples of ascending and descending order on result outputs.
  • Use the same consistent collection and documents for all examples
  • The limit documentation could be clearer for new users. We should fully explain that as long as "limit" number of documents requires less than 32MB the sort will continue
  • We should provide some form of example to illustrate using sort and limit to get under the 32MB limit (or link to a tutorial where we do this)
  • "by way of an optimized algorithm". What algorithm? What does it do? This feels like us abdicating an explanation to "magic". We should either explain things or remove this reference. Alternately, we could link to a page which explains the algorithm for expert users.
  • Natural order is not really "Order stored on disk", its the order stored within our extents (collection level data storage extents, not on disk storage extents). It may be better to call natural order the "storage order", then provide some relevant examples and then refer to a natural order page for more details.
  • Natural order can change if documents are deleted and new documents inserted into the now free spaces, not simply when updates move documents


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

Author:

{u'username': u'kay-kim', u'name': u'kay', u'email': u'kay.kim@10gen.com'}

Message: DOCS-2738 edits to cursor.sort page
Branch: v2.4
https://github.com/mongodb/docs/commit/555a44fc5d1f1740d3015e631f7612930dad27be

Comment by Githook User [ 18/Mar/14 ]

Author:

{u'username': u'kay-kim', u'name': u'kay', u'email': u'kay.kim@10gen.com'}

Message: DOCS-2738 edits to cursor.sort page
Branch: master
https://github.com/mongodb/docs/commit/402d10ea40070e22ad0d65f0fb358ab99194c646

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