KT-20357: Add sample usages for array constructor functions #5521
Conversation
oscarArismendi
requested review from
fzhinkin,
ilya-g and
qwwdfsad
as code owners
oscarArismendi
changed the title
|
Hi, just checking if I need to do anything else to move this toward review |
| /** | ||
| * Returns an array containing the specified [Double] numbers. | ||
| * | ||
| * @sample samples.collections.Arrays.Constructors.doubleArrayOf |
There was a problem hiding this comment.
Please update corresponding actual declarations.
There was a problem hiding this comment.
Did it in a74af86
Let me know if that's what you wanted
fzhinkin
added
the
Standard Library Sample
oscarArismendi
force-pushed
the
KT-20357-array-of-samples
branch
from
0713c9e to
bbe6420
Compare
oscarArismendi
force-pushed
the
KT-20357-array-of-samples
branch
from
bbe6420 to
b49f96e
Compare
| val byteArray = arrayOf(1, 2, 3) | ||
| assertPrints(byteArray.contentToString(), "[1, 2, 3]") | ||
|
|
||
| val booleanArray = arrayOf(true, false, true) |
There was a problem hiding this comment.
@oscarArismendi, could you please elaborate why it's necessary to showcase creation of an array for every boxed primitive type?
In some way, it could be misleading as it gives an impression that arrayOf(true, false, true) and booleanArrayOf(true, false, true) are equivalent, but they are not.
Perhaps, something like val strings = arrayOf("Hello", "world") would be enough.
But it might be worth also adding a sample like val numbers: Array<Number> = arrayOf(3.14, 42L, 0.123f)
There was a problem hiding this comment.
@fzhinkin My thought process was that I wanted to show all the possibilities, but now that you mention it, I agree it’s misleading. I’ll keep only the emptyArray example from the arrayOf test and add the two examples you suggested
…rd library Related issue: KT-20357
…tions in standard library Related issue: KT-20357
Related issue: KT-20357
… standard library Related issue: KT-20357
oscarArismendi
force-pushed
the
KT-20357-array-of-samples
branch
from
b49f96e to
ab436f7
Compare
2 participants
Added a sample function for constructors in
Library.kt.These are just the basics, but I remember when I was learning Kotlin that having examples for everything would’ve made me spend more time in the official documentation.
Related issue: KT-20357