chore: clean up docs

mongodb · May 8, 2024 · 0d68e29 · 0d68e29
1 parent a1a37d6
commit 0d68e29
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 9 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,14 +1,11 @@
 # Changelog
 
-MongoDB Plugin that does a lot of features. This is markdown.
+MongoDB plugin for IntelliJ IDEA.
 
 ## [Unreleased]
 
 ### Added
 
-- Something Added
-- New Feature :happy:
-
 ### Changed
 
 ### Deprecated

diff --git a/packages/jetbrains-plugin/build.gradle.kts b/packages/jetbrains-plugin/build.gradle.kts
@@ -106,7 +106,7 @@ changelog {
     headerParserRegex.set("""(\d+\.\d+.\d+)""".toRegex())
     introduction.set(
         """
-        MongoDB Plugin that does a lot of features. This is markdown.
+        MongoDB plugin for IntelliJ IDEA.
         """.trimIndent()
     )
     itemPrefix.set("-")

diff --git a/packages/jetbrains-plugin/src/main/kotlin/com/mongodb/jbplugin/observability/LogMessage.kt b/packages/jetbrains-plugin/src/main/kotlin/com/mongodb/jbplugin/observability/LogMessage.kt
@@ -33,11 +33,14 @@ internal class LogMessageBuilder(private val gson: Gson, message: String) {
 /**
  * This class will be injected in probes to build log messages. Usually like:
  * ```kt
- * @Service
- * class MyProbe(private val logMessage: LogMessage?) {
+ * @Service(Service.Level.PROJECT)
+ * class MyProbe(private val project: Project) {
+ *  ...
+ *     fun somethingProbed() {
+ *        val logMessage = project.getService(LogMessage::class.java)
+ *        log.info(logMessage.message("My message").put("someOtherProp", 25).build())
+ *     }
  *  ...
- *  fun somethingProbed() {
- *     log.info(logMessage?.message("My message").put("someOtherProp", 25).build())
  * }
  * ```
  *