Removed confusing array of types in readcsv help

[mbeltagy]

No description provided.

[tkelman]

this isn't an array, it's actually trying to say that the type input is optional (another reason why I think we should just use Julia syntax for that optional argument convention in docstrings)

[ViralBShah]

Cc @tanmaykm

[mbeltagy]

I believe we need better standards for documenting optional arguments. In the manual I sometimes see it as

foo(arg [,optional_arg])

So maybe we need to have that for all optional arguments in the docs, instead of the often ambiguous

foo(arg, [optional_arg])

[tanmaykm]

I think we can merge this.
And also open an issue to have a uniform standard for documenting optional arguments.

[tkelman]

it would need a genstdlib run. and it's probably covered by #18041, but worth checking

[mbeltagy]

I checked #18041 and found that the [optional_arg] style was used. This is often at odds with the manual. So I created #18318.

[kshyatt]

@mbeltagy in that PR I was just trying to get as much stuff out of HelpDB as possible, not really overhaul all those docs (although some of that ended up happening). I agree that the square brackets aren't great. Have you run genstdlib? Is this good to go?

[mbeltagy]

@kshyatt I ran genstdlib. It is good to go.
I could start an effort to remove square brackets from the docs, if you think it is worth while. I get a feeling that the community has not been happy with them for some time. (c.f. #4902)

[tkelman]

A correct run of genstdlib needs to happen after bootstrapping and should change the rst docs. You'd need to commit and push that change.