[STDCXX-1048] rotate() description's example seems misleading or wrong

• Type: Improvement
• Status: Open
• Priority: Minor
• Resolution: Unresolved
• Affects Version/s: 4.2.1
• Component/s: Documentation
• Labels: algorithm documentation rotate rotate_copy
• Severity: Usability
• Assignee: Unassigned
• Reporter: Jim Bell
• Created: 30/Mar/10 23:55
• Updated: 30/Mar/10 23:55

Description

rotate() description's example seems misleading at best. It says:

Say that we have the sequence:

2 4 6 8 1 3 5

If we call rotate() with mid pointing to 5, the two segments are

2 4 6 8 and 1 3 5

To get the specified result, the mid must point to the fifth element, counting up from 1. But it would be more accurate to say "with mid pointing to advance(start, 4) ..." Further, the typeface for "5" makes it look like the item value 5, the last position on the original sequence list.