You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Autocomplete in my editor helpfully offers these suggestions:
The docstring for ds/concat says this:
Concatenate datasets in place using a copying-concatenation.
Which I find sort of confusing given that the three functions concat, concat-inplace, and concat-copying seem to imply that in place and copying are different.
Improve arglists
Also, the arglist of all three functions is: [dataset & args], which sort of obscures the fact that you're supposed to pass in many arguments each a dataset. Would [& datasets] be better? ... clojure.core/concat has [x y & zs] which I also sort of don't like because it obscures the fact that the arguments are supposed to be sequences.
Improve docstrings
My proposal would be for re-written docstrings on all three of these functions with
mention of the input and output return types
a short working example of usage, so users don't have to wonder if they need to call apply
an indication in all three to which one is the one you probably want (is it ds/concat?) with a short explanation of why you occasionally might want the other two, with, if possible, a short example of their ideal use...
The text was updated successfully, but these errors were encountered:
I did the absolute minimum possible to make the docstrings clearer - so this is partially addressed at this point - feel free to repoen if you want to have someone tackle this is more depth.
Agreed that's an improvement, I still think examples would go a long way. I'll put the good first issue tag on here and some enthusiast will come and do it. (:
Autocomplete in my editor helpfully offers these suggestions:
The docstring for
ds/concat
says this:Which I find sort of confusing given that the three functions
concat
,concat-inplace
, andconcat-copying
seem to imply that in place and copying are different.Improve arglists
Also, the arglist of all three functions is:
[dataset & args]
, which sort of obscures the fact that you're supposed to pass in many arguments each a dataset. Would[& datasets]
be better? ...clojure.core/concat
has[x y & zs]
which I also sort of don't like because it obscures the fact that the arguments are supposed to be sequences.Improve docstrings
My proposal would be for re-written docstrings on all three of these functions with
apply
ds/concat
?) with a short explanation of why you occasionally might want the other two, with, if possible, a short example of their ideal use...The text was updated successfully, but these errors were encountered: