Is there a good naming convention for this ```fun doSomethin kotlinlang #codingconventions

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

Manuel Wrage

11/20/2020, 8:36 AM

Is there a good naming convention for this?

fun doSomething()
suspend fun doSomethingSuspending()

elizarov

11/20/2020, 9:31 AM

suspend fun doSomething()
fun doSomethingBlocking()

👍 13

Rationale:

Blocking

variant is more dangerous and, what's worse, can be called from anywhere (by mistake), so it must have a longer name

➕ 7

Manuel Wrage

11/20/2020, 9:34 AM

Ok and what if i have something like this

// fire and forget
fun dispatch(action: Action)
// dispatches the action and suspends until consumed
suspend fun dispatchSuspend(action: Action)

As an alternative i could do this?

fun dispatch(action: Action): Deferred<Unit>

elizarov

11/20/2020, 9:51 AM

That's a totally different story. In this case use different verbs or invent some other way to differentiate between them. In the latter case cal the function

dispatchAsync

to highlight the fact that it only starts the action, but does not wait for its completion in any way.

Manuel Wrage

11/20/2020, 4:27 PM

Ok thanks.

2 Views

#codingconventions Join Slack