Does anyone know if there is a way to verify code...
# announcementsn
nyxcharon
12/19/2017, 6:41 PMDoes anyone know if there is a way to verify code snippets in Kotlin docs? For example if I document a function and include an example of how to use it, to verify that it works as intended? Similar to rust or python? Example for python: https://docs.python.org/2/library/doctest.html
s
Shawn
12/19/2017, 6:42 PMwow that’s extra af lol, but I guess that’s python for you
Shawn
12/19/2017, 6:44 PMI’d probably guess that there isn’t a good Kotlin equivalent considering the REPL and the Kotlin JSR-223 stuff isn’t being developed on as rapidly
n
nyxcharon
12/19/2017, 6:44 PMIt’s good to verify your docs match what the current code implementation does.
s
Shawn
12/19/2017, 6:47 PMyou’re not wrong, but that doesn’t mean that having a mechanism that reads your docstrings to parse a syntax that mimics what the interactive interpreter output looks like to validate your snippets isn’t a bit excessive
Shawn
12/19/2017, 6:48 PMI mean, it’s not so bad considering how docstrings work in python and how they’re literally properties of the objects you write them in, but still
Shawn
12/19/2017, 6:51 PMthat’s probably a bit of a hurdle for Kotlin, considering comments are just comments, though it wouldn’t be infeasible to add this kind of validation as a build step. It’d probably be out of scope for the Kotlin folks, though. Maybe as kotlin scripting gets better we’ll see a gradle plugin or something similar that provides this kind of validation
i
ilya.gorbunov
12/19/2017, 9:02 PM@nyxcharon You can use @sample tag and refer to a function with a compiled code sample: http://kotlinlang.org/docs/reference/kotlin-doc.html#block-tags
d
dh44t
12/19/2017, 10:37 PM5 Views