2 files changed, 6 insertions, 4 deletions
diff --git a/chiselFrontend/src/main/scala/chisel3/core/package.scala b/chiselFrontend/src/main/scala/chisel3/core/package.scala
index ac69ca33..87e8c66d 100644
--- a/chiselFrontend/src/main/scala/chisel3/core/package.scala
+++ b/chiselFrontend/src/main/scala/chisel3/core/package.scala
@@ -2,12 +2,12 @@
 
 package chisel3
 
+/**
+ * These definitions exist to deal with those clients that relied on chisel3.core.
+ * They are deprecated and will be removed in the future.
+ */
 package object core {
 
-  /**
-  * These definitions exist to deal with those clients that relied on chisel3.core
-  * They will be deprecated in the future.
-  */
   @deprecated("Use the version in chisel3._", "3.3")
   val CompileOptions = chisel3.CompileOptions
 
diff --git a/chiselFrontend/src/main/scala/chisel3/package.scala b/chiselFrontend/src/main/scala/chisel3/package.scala
index d6c590b4..16d10ff7 100644
--- a/chiselFrontend/src/main/scala/chisel3/package.scala
+++ b/chiselFrontend/src/main/scala/chisel3/package.scala
@@ -1,5 +1,7 @@
 // See LICENSE for license details.
 
+/** This package contains the main chisel3 API.
+ */
 package object chisel3 {    // scalastyle:ignore package.object.name
   import internal.firrtl.{Port, Width}
   import internal.sourceinfo.{SourceInfo, VecTransform}