Raku / user-experience

Identifying issues in and improving the Raku user experience
Artistic License 2.0
25 stars 5 forks source link

inconsequent use of dashes and underscores in identifiers in class Parameter #49

Open MARTIMM opened 1 year ago

MARTIMM commented 1 year ago

I should have read the documentation properly to find the mistake I made. But I still feel the need to mention the problem I faced.

I was working on a way to create a native function with a callback routine in the signature of the argument list. From a glimpse in the documentation, I saw that I could get the callback signature information by using the method .sub_signature on that particular parameter. Too quick thinking brought me to write sub_signature => :(…) to create that part of a parameter. This did not work of course because I should have written sub-signature => :(…) when creating the parameter.

There are more of those differences in that module; For example, methods usage-name with a dash, while coerce_type, named_names, type_captures, and sub_signature are with an underscore. On the other hand, all named arguments to .new() are with dashes.

This is not a too big problem because the documentation is correct and the Raku compiler does what it says. The only thing I want to say is that it would be nice to be able to guess the named arguments from other info in the same document and vice versa.