wip Stability guarantees disclaimer

Author: anatoliykmetyuk

library/src/scala/compiletime/testing/Error.scala

@@ -1,6 +1,14 @@
 package scala.compiletime.testing
 
-/** Represents a compile-time error */
+/** Represents a compile-time error.
+ *
+ *  @see scala.compiletime.testing.typeCheckErrors
+ *
+ *  IMPORTANT: No stability guarantees are provided on the format of these
+ *  errors. This means the format and the API may change from
+ *  version to version. This API is to be used for testing purposes
+ *  only.
+ */
 case class Error(message: String, lineContent: String, column: Int, kind: ErrorKind)
 
 /** An error can be either a parse-time or a typecheck-time */

library/src/scala/compiletime/testing/package.scala

@@ -14,7 +14,12 @@ package object testing {
   inline def typeChecks(inline code: String): Boolean =
     error("`typeChecks` was not checked by the compiler")
 
-  /** Whether the code type checks in the current context?
+  /** Whether the code type checks in the current context? If not,
+   *  returns a list of errors encountered on compilation.
+   *  IMPORTANT: No stability guarantees are provided on the format of these
+   *  errors. This means the format and the API may change from
+   *  version to version. This API is to be used for testing purposes
+   *  only.
    *
    *  @param code The code to be type checked
    *