Forum: Ruby-dev [ruby-trunk - RubySpec #7803][Open] RDoc documentation: `Array#&` clarification

Posted by Tsuyoshi S. (tsuyoshi_s)
on 2013-02-08 07:47
(Received via mailing list)
Issue #7803 has been reported by sawa (Tsuyoshi Sawada).

----------------------------------------
RubySpec #7803: RDoc documentation: `Array#&` clarification
https://bugs.ruby-lang.org/issues/7803

Author: sawa (Tsuyoshi Sawada)
Status: Open
Priority: Normal
Assignee:
Category:
Target version:


In the RDoc documentation for `Array#&`, it does not mention whether the 
order of the elements in the returned array preserves the order in the 
receiver. There is a question raised regarding this point in 
stackoverflow:

    http://stackoverflow.com/questions/14764135/is-ord...

and it mentions that that is included in the test for RubySpec

    https://github.com/rubyspec/rubyspec/blob/master/c...

so it looks like that is taken for granted, but it is not guaranteed. If 
it is indeed a feature, then that should be written in the document. If 
not, (meaning the order might not be preserved in a future 
implementation), then that should also be mentioned in the document as a 
warning. The documentation for `Array#-` makes that point clear:

    Array Difference---Returns a new array that is a copy of the 
original array, removing any items that ...

so, perhaps the docmentation for `Array#&` should be written along the 
same line.
Posted by ko1 (Koichi Sasada) (Guest)
on 2013-02-17 06:18
(Received via mailing list)
Issue #7803 has been updated by ko1 (Koichi Sasada).

Category set to DOC
Assignee set to zzak (Zachary Scott)
Target version set to next minor


----------------------------------------
RubySpec #7803: RDoc documentation: `Array#&` clarification
https://bugs.ruby-lang.org/issues/7803#change-36375

Author: sawa (Tsuyoshi Sawada)
Status: Open
Priority: Normal
Assignee: zzak (Zachary Scott)
Category: DOC
Target version: next minor


In the RDoc documentation for `Array#&`, it does not mention whether the 
order of the elements in the returned array preserves the order in the 
receiver. There is a question raised regarding this point in 
stackoverflow:

    http://stackoverflow.com/questions/14764135/is-ord...

and it mentions that that is included in the test for RubySpec

    https://github.com/rubyspec/rubyspec/blob/master/c...

so it looks like that is taken for granted, but it is not guaranteed. If 
it is indeed a feature, then that should be written in the document. If 
not, (meaning the order might not be preserved in a future 
implementation), then that should also be mentioned in the document as a 
warning. The documentation for `Array#-` makes that point clear:

    Array Difference---Returns a new array that is a copy of the 
original array, removing any items that ...

so, perhaps the docmentation for `Array#&` should be written along the 
same line.
Posted by zzak (Zachary Scott) (Guest)
on 2013-02-23 03:51
(Received via mailing list)
Issue #7803 has been updated by zzak (Zachary Scott).

Status changed from Open to Closed

Resolved by r39415
----------------------------------------
RubySpec #7803: RDoc documentation: `Array#&` clarification
https://bugs.ruby-lang.org/issues/7803#change-36815

Author: sawa (Tsuyoshi Sawada)
Status: Closed
Priority: Normal
Assignee: zzak (Zachary Scott)
Category: DOC
Target version: next minor


In the RDoc documentation for `Array#&`, it does not mention whether the 
order of the elements in the returned array preserves the order in the 
receiver. There is a question raised regarding this point in 
stackoverflow:

    http://stackoverflow.com/questions/14764135/is-ord...

and it mentions that that is included in the test for RubySpec

    https://github.com/rubyspec/rubyspec/blob/master/c...

so it looks like that is taken for granted, but it is not guaranteed. If 
it is indeed a feature, then that should be written in the document. If 
not, (meaning the order might not be preserved in a future 
implementation), then that should also be mentioned in the document as a 
warning. The documentation for `Array#-` makes that point clear:

    Array Difference---Returns a new array that is a copy of the 
original array, removing any items that ...

so, perhaps the docmentation for `Array#&` should be written along the 
same line.
Posted by zzak (Zachary Scott) (Guest)
on 2013-02-23 03:52
(Received via mailing list)
Issue #7803 has been updated by zzak (Zachary Scott).

% Done changed from 0 to 100


----------------------------------------
RubySpec #7803: RDoc documentation: `Array#&` clarification
https://bugs.ruby-lang.org/issues/7803#change-36816

Author: sawa (Tsuyoshi Sawada)
Status: Closed
Priority: Normal
Assignee: zzak (Zachary Scott)
Category: DOC
Target version: next minor


In the RDoc documentation for `Array#&`, it does not mention whether the 
order of the elements in the returned array preserves the order in the 
receiver. There is a question raised regarding this point in 
stackoverflow:

    http://stackoverflow.com/questions/14764135/is-ord...

and it mentions that that is included in the test for RubySpec

    https://github.com/rubyspec/rubyspec/blob/master/c...

so it looks like that is taken for granted, but it is not guaranteed. If 
it is indeed a feature, then that should be written in the document. If 
not, (meaning the order might not be preserved in a future 
implementation), then that should also be mentioned in the document as a 
warning. The documentation for `Array#-` makes that point clear:

    Array Difference---Returns a new array that is a copy of the 
original array, removing any items that ...

so, perhaps the docmentation for `Array#&` should be written along the 
same line.
Please log in before posting. Registration is free and takes only a minute.
Existing account (Switch to SSL-encrypted connection)
NEW: Do you have a Google/GoogleMail or Yahoo account? No registration required!
Log in with Google account | Log in with Yahoo account
No account? Register here.