conversation kotlinlang #arrow-contributors

Channels

100daysofcode

100daysofkotlin

100daysofkotlin-2021

androidgithubprojects

cincinnati-user-group

competitive-programming

event21-community-content

java-to-kotlin-refactoring

jvm-ir-backend-feedback

kotlin-multiplatform-contest

kotlinultimatechallenge

myndocs-oauth2-server

naming

navigation-architecture-component

practical-functional-programming

proguard

prozis-android-backup

refactoring-to-kotlin

russian-kotlinasfirst

skia-wasm-interop-temp

stayhungrystayfoolish

swagger-gradle-codegen

tricity-kotlin-user-group

Title

raulraja

11/16/2018, 10:34 PM

Runnable_snippets_declared_in_code.kt

simon.vergauwen

11/19/2018, 10:16 AM

@raulraja this way the actual result is never in the kdocs, right?

Aren’t we better of writing samples like the following then.

Option.just(1).map { it + 1 } == Some(2)

. Something in test form.

raulraja

11/19/2018, 10:39 AM

If they are runnable the result doesn't show until you play

simon.vergauwen

11/19/2018, 10:39 AM

I meant in the Kdocs, not the arrow docs.

raulraja

11/19/2018, 10:39 AM

I see

You mean in the actual source?

simon.vergauwen

11/19/2018, 10:40 AM

raulraja

11/19/2018, 10:41 AM

Ank should print out the resulting value in the rendered doc but if you want the result when people are reading the sources then yeah

simon.vergauwen

11/19/2018, 10:41 AM

We could do something like

fun A.shouldEqual(other: A): Unit

that prints the result in runnable snippet but it showcases the result also in the actual code.

Just thinking out loud because a snippet like the following might not tell the user a lot (enough).

fun main(args: Array<String>) {
  listOf(1, 2, 3)
    .map { async { getUserById(it) } }
    .sequence(DeferredK.applicative())
}

Compared to

fun main(args: Array<String>) {
  listOf(1, 2, 3)
    .map { async { getUserById(it) } }
    .sequence(DeferredK.applicative()) shouldEqual
       async { listOf(User(1), User(2), User(3)) }
}

Same here. This is immediately clear in the Kdocs IMO. https://github.com/arrow-kt/arrow/pull/1133/files#diff-24acbdf947a678588c475a4056c19198R22

No need to jump to website and run snippet to clarify.

raulraja

11/19/2018, 12:16 PM

yes, but as a user I still want to go and modify those values

and see how the expression behaves with different values or code

if that comparison also uses

println

for the resulting value to get the best of both worlds then yeah

simon.vergauwen

11/19/2018, 12:17 PM

Ye that’s what I’d propose

raulraja

11/19/2018, 12:17 PM

👍 sounds great to me

sorry I read it backwards

yeah we were in agreement many msgs ago 😛

simon.vergauwen

11/19/2018, 12:18 PM

😄

3 Views

#arrow-contributors Join Slack