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

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-order-preserved-in-arrays-when-intersection-is-done

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

https://github.com/rubyspec/rubyspec/blob/master/core/array/intersection_spec.rb#L16

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.

Issue #7803 has been updated by ko1 (Koichi Sasada).

Category set to DOC
Assignee set to zzak (Zachary S.)
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 S.)
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-order-preserved-in-arrays-when-intersection-is-done

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

https://github.com/rubyspec/rubyspec/blob/master/core/array/intersection_spec.rb#L16

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.

Issue #7803 has been updated by zzak (Zachary S.).

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 S.)
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-order-preserved-in-arrays-when-intersection-is-done

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

https://github.com/rubyspec/rubyspec/blob/master/core/array/intersection_spec.rb#L16

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.

Issue #7803 has been updated by zzak (Zachary S.).

% 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 S.)
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-order-preserved-in-arrays-when-intersection-is-done

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

https://github.com/rubyspec/rubyspec/blob/master/core/array/intersection_spec.rb#L16

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.

This forum is not affiliated to the Ruby language, Ruby on Rails framework, nor any Ruby applications discussed here.

| Privacy Policy | Terms of Service | Remote Ruby Jobs