Added 3 APIs for Flatten function

[zaleslaw]

Fixed #292

[zaleslaw]

@koperagen @Jolanrensen I have a question: why do we miss KProperties as an Access API in the documentation (I could not find tabs with that kind of access). Is it related that it requires a plugin and it is somehow "difficult" for a user?

I also suggest updating the documentation in PRs together with the API changes as a part of triad (code, tests, docs)

[Jolanrensen]

@koperagen @Jolanrensen I have a question: why do we miss KProperties as an Access API in the documentation (I could not find tabs with that kind of access). Is it related that it requires a plugin and it is somehow "difficult" for a user?

I also suggest updating the documentation in PRs together with the API changes as a part of triad (code, tests, docs)

Like here? https://kotlin.github.io/dataframe/kpropertiesapi.html

[zaleslaw]

Not, probably I wrote unclear. We have 4 apis but on many pages in operations we have 3 tabs only without Kproperties

[Jolanrensen]

you renamed this function to flatten_properties in Modify.kt

We use Korro to check that samples in stardust are actually compilable. So make sure that all examples in markdown are surrounded like
<!---FUN someFunctionName-->
your example, which is between // SampleStart and // SampleEnd comments in samples/api/Modify.kt inside a function with the same name.
<!---END-->

[zaleslaw]

Look, for example insert

It has in documentation the following

<!---FUN insert-->
<tabs>
<tab title="Properties">

and in modify the following

  @Test
    fun insert_properties() {
        // SampleStart
        df.insert("year of birth") { 2021 - age }.after { age }
        // SampleEnd
    }

    @Test
    fun insert_accessors() {
        // SampleStart
        val year = column<Int>("year of birth")
        val age by column<Int>()

        df.insert(year) { 2021 - age }.after { age }
        // SampleEnd
    }

    @Test
    fun insert_strings() {
        // SampleStart
        df.insert("year of birth") { 2021 - "age"<Int>() }.after("age")
        // SampleEnd
    }

Looks like I do the same, but is the best way to check that I am right?

[zaleslaw]

Template looks like: name of function underscore acess api

[Jolanrensen]

Oh now I see! Didn't know this was possible. Cool :)

[Jolanrensen]

Not, probably I wrote unclear. We have 4 apis but on many pages in operations we have 3 tabs only without Kproperties

I see, probably that is because it was added later. Should definitely be the same everywhere :)

[koperagen]

Not, probably I wrote unclear. We have 4 apis but on many pages in operations we have 3 tabs only without Kproperties

I think it was done deliberately, but might be discussed. There's not much value in using this API outside its rather narrow use case, like described here https://kotlin.github.io/dataframe/kpropertiesapi.html. So using only 3 APIs in samples was probably an attempt to find a balance between providing this feature for advanced use cases and not confusing people as to what to use.

[zaleslaw]

@Jolanrensen fixed the review