Add a comment about embedKernel function

ileasile · ileasile · commit 1fe6c14fff6c · 2020-09-28T22:46:33.000+03:00
diff --git a/src/main/kotlin/org/jetbrains/kotlin/jupyter/ikotlin.kt b/src/main/kotlin/org/jetbrains/kotlin/jupyter/ikotlin.kt
@@ -75,6 +75,11 @@ fun main(vararg args: String) {
     }
 }
 
+/**
+ * This function is to be run in projects which use kernel as a library,
+ * so we don't have a big need in covering it with tests
+ */
+@Suppress("unused")
 fun embedKernel(cfgFile: File, libraryFactory: LibraryFactory?, scriptReceivers: List<Any>?) {
     val cp = System.getProperty("java.class.path").split(File.pathSeparator).toTypedArray().map { File(it) }
     val config = KernelConfig.fromConfig(

Original file line number	Diff line number	Diff line change
`@@ -75,6 +75,11 @@ fun main(vararg args: String) {`
`75`	`75`	`}`
`76`	`76`	`}`
`77`	`77`
	`78`	`+/**`
	`79`	`+ * This function is to be run in projects which use kernel as a library,`
	`80`	`+ * so we don't have a big need in covering it with tests`
	`81`	`+ */`
	`82`	`+@Suppress("unused")`
`78`	`83`	`fun embedKernel(cfgFile: File, libraryFactory: LibraryFactory?, scriptReceivers: List<Any>?) {`
`79`	`84`	`val cp = System.getProperty("java.class.path").split(File.pathSeparator).toTypedArray().map { File(it) }`
`80`	`85`	`val config = KernelConfig.fromConfig(`