read -> unfold + Add documentation for unfold #159 #206
Conversation
| public inline fun <reified T> DataColumn<T>.unfold(): AnyCol = when (kind()) { | ||
| ColumnKind.Group, ColumnKind.Frame -> this | ||
| else -> when { | ||
| isPrimitive() -> this |
There was a problem hiding this comment.
While the name unfold() does make sense for isPrimitive() and the else statement where the object is turned into a dataframe one property at a time, for the reading of a file or url the name read() makes way more sense. Would it be a good idea to have both names? Or is this what you're planning to do?
There was a problem hiding this comment.
I reckon people would use it for the same purpose, thus one function and one name.
It's not clear what function does from its name though. Even read is more like read + replace. So people would have to read docs / kdocs to find out anyway.
There was a problem hiding this comment.
speaking of, how would you make kdocs in this situation? i'm in dither over this because duplication and maintenance
There was a problem hiding this comment.
hmm I'd definitely keep the old functions, annotate them with
@Deprecated("read is now called unfold", ReplaceWith("unfold"), DeprecationLevel.ERROR)And then simply KDoc the read() functions with @see unfold
There was a problem hiding this comment.
But what does read/unfold do with a file or url? I'd say it still "read"s those right? Even calling DataFrame.read() I'd see "unfold" as only "unfolding" an object into a dataframe.
Maybe we could make that readFile and readUrl?
Jolanrensen
changed the title
…arate file. removed File and URL retrieval from unfold method. Moved example of that to replace.md, updated other docs too
2 participants
No description provided.