Add docstring for '*' variants of functions.

andrewchambers / janet-sh

Shorthand shell like functions for janet.

82 stars 6 forks source link

Closed crocket closed 3 years ago

sogaiu commented 3 years ago

Nice! Especially the short examples.

Below are some additional observations.

I noticed that the docstrings use the word "array", but the examples seem to be using tuples. May be that could be confusing?
Perhaps the docstrings of the macro versions could use similar examples as IIUC they are possibly more likely to be used than the functions versions. I'm willing to do this if having examples is acceptable.
How about using the word "function" instead of "non-macro" in the docstrings?

andrewchambers commented 3 years ago

thanks! I really appreciate this work.

crocket commented 3 years ago

@sogaiu You are welcome to submit more pull requests. I used array as a plain english word because I didn't like the word, tuple.

sogaiu commented 3 years ago

@crocket Thanks for the explanation (and submitting the original PR).

I will consider an additional PR.