Array#index more logical and add a rdoc extension to the README files

[robin850]

Hello

Sorry if I have made mistakes but I'm quite a newbie. I found more logical the Array#index method to return an array of indexes and not the index of the first occurrence.

Then, I found nicer to move the README files with a rdoc extension for more readability on Github for example.

Have a nice day.

[zzak]

Hello Robin,

I've added your Array#index feature patch as #6572.

I didn't include the README.rdoc feature since it will probably be rejected, I've requested a similar patch recently with the response being:

@drbrain:
Since github is not the primary place people go to learn about ruby I think it is OK to keep "README"
with no extension.

and

@mame:
README is not for github, but for newbie.
README extensions often represent platform in Unix culture.
".rdoc" may confuse users familiar with Unix but unfamiliar
with Ruby's toolchain.

See #6388

[robin850]

@zzak oh, sorry, I didn't know that we have to first create a ticket on the bug tracker. I'm sorry. Thank you so much. Thanks for the README. I think newbie are more apt to come on Github first and then clone the repository on their computer but it's true that Github it's not the primary place.

Thank you for your answer ! Have a nice day :)

[trans]

Doesn't this break the current "contract" of Array#index? I think this is a very bad idea. This should be a new method, e.g. index_all or something to that effect.

[robin850]

@trans : thank you, I hope it's good (I have called the method Array#indexes and I add an aliase which is Array#index_all).

Thank you. Have a nice day.

[robin850]

Sorry I've missed the doc when I move the method.

[drbrain]

indexes is not declared as a VALUE, so I don't think this will compile under most C compilers.

If indexes is supposed to be a VALUE (from the return type of this function), you want to use one of the rb_ary_new family functions to allocate a ruby Array of the correct size.

Returning the pointer from a bare malloc() will crash ruby.

Not checking the return value of malloc() will crash any C program.

[drbrain]

This will need tests before it can be committed. Tests you add would go in test/ruby/test_array.rb

Since this is a feature request for Array you will need to discuss it on https://bugs.ruby-lang.org before it can be committed (regardless of implementation). You can either add the reasoning for this addition to #6572 or you can create a new ticket (and I will close #6572). The ticket should provide examples of usage and reasons for inclusion in ruby.

[drbrain]

There is no implementation for argc > 0, so this implementation does not match the documentation.

[robin850]

@drbrain ; what do you mean when you say that "There is no implementation for argc > 0" please ? I wait your answer to write tests and open the issue on the Ruby's bug tracker.

[drbrain]

Your documentation says I should be able to ary.indexes "a" when a single argument is passed, for calling convention -1, argc will be 1 and argv will be a pointer to a ruby String "a".

You do not check if argc > 0 nor do you use argv so your implementation will not return any value.

I will add a line comment too.

[drbrain]

Since there is no return outside this if (argc == 0) { block, a "control reaches end of non-void function" error will be generated.

This will crash ruby. You should handle argc > 0 here.

[robin850]

@drbrain : I have open an issue on bug tracker, it's #6596.

[zzak]

I'm closing this, please refer to Feature #6596 on redmine. Thank you!