CU-fb6wcj Docs: Quickstart description changes #2309
Conversation
Co-authored-by: Simon Vergauwen <nomisRev@users.noreply.github.com>
|
@nomisRev added setup in line in the same doc |
| ##### Arrow Core | ||
|
|
||
| ```groovy | ||
| apply plugin: 'kotlin-kapt' | ||
|
|
||
| def arrow_version = "0.13.0" | ||
| dependencies { | ||
| implementation "io.arrow-kt:arrow-core:$arrow_version" | ||
| } | ||
| ``` | ||
|
|
||
| ##### Arrow Core + Arrow Optics | ||
|
|
||
| ```groovy | ||
| apply plugin: 'kotlin-kapt' | ||
|
|
||
| def arrow_version = "0.13.0" | ||
| dependencies { | ||
| implementation "io.arrow-kt:arrow-optics:$arrow_version" | ||
| kapt "io.arrow-kt:arrow-meta:$arrow_version" | ||
| } | ||
| ``` | ||
|
|
||
| ##### Arrow Core + Arrow Fx | ||
|
|
||
| ```groovy | ||
| def arrow_version = "0.13.0" | ||
| dependencies { | ||
| implementation "io.arrow-kt:arrow-fx-coroutines:$arrow_version" | ||
| } | ||
| ``` |
There was a problem hiding this comment.
Can we combine this into a single block? I think it's as clear but only a third so long.
apply plugin: 'kotlin-kapt'
def arrow_version = "0.13.0"
dependencies {
// Arrow Core
implementation "io.arrow-kt:arrow-core:$arrow_version"
// Arrow Fx
implementation "io.arrow-kt:arrow-fx-coroutines:$arrow_version"
// Arrow Optics
implementation "io.arrow-kt:arrow-optics:$arrow_version"
kapt "io.arrow-kt:arrow-meta:$arrow_version"
}
There was a problem hiding this comment.
In the past people would complain and ask in the channel, what to do if they solely need Core or Fx or Optics, that's why we split that.
There was a problem hiding this comment.
The single block's concern is that most users seem to copy and paste everything they find on this page. I propose we do another pass to this page before 1.0 in a different PR to address the dependencies section and how they are presented.
Minor language edits.
|
|
||
| def arrow_version = "0.13.0" | ||
| dependencies { | ||
| implementation "io.arrow-kt:arrow-optics:$arrow_version" |
There was a problem hiding this comment.
Are we sure we don't need to include core? In such case we should move to api in the build.config
There was a problem hiding this comment.
@aballano I'm not familiar with best gradle practices, but after reading the diff between API and impl makes sense. Probably we should make those changes in a different issue or PR since it involves build files and can potentially affect the way things are packaged for the release.
Co-authored-by: Rachel M. Carmena <rachelcarmena@users.noreply.github.com>
Co-authored-by: Rachel M. Carmena <rachelcarmena@users.noreply.github.com>
Co-authored-by: Rachel M. Carmena <rachelcarmena@users.noreply.github.com>
Co-authored-by: Alberto Ballano <aballano@users.noreply.github.com>
@MaureenElsberry @jkmcclellan tagging you in case one of you can help with a lang review in this doc. This is what will show up in the Arrow Readme and Quick Start links.