correct Kdoc and test

oppia · Nov 11, 2024 · 2c505b0 · 2c505b0
1 parent 277fabb
commit 2c505b0
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 2 deletions.
diff --git a/scripts/src/java/org/oppia/android/scripts/common/model/GitHubIssue.kt b/scripts/src/java/org/oppia/android/scripts/common/model/GitHubIssue.kt
@@ -15,6 +15,12 @@ data class GitHubIssue(
   @Json(name = "pull_request") val pullRequest: PullRequestInfo? = null
 )
 
+/**
+ * Data class representing information about a pull request associated with a GitHub issue.
+ *
+ * @property url the URL of the pull request, if it exists. This provides the link to the specific
+ *     pull request associated with the issue on GitHub.
+ */
 @JsonClass(generateAdapter = true)
 data class PullRequestInfo(
   @Json(name = "url") val url: String? = null

diff --git a/scripts/src/javatests/org/oppia/android/scripts/todo/TodoOpenCheckTest.kt b/scripts/src/javatests/org/oppia/android/scripts/todo/TodoOpenCheckTest.kt
@@ -803,9 +803,19 @@ class TodoOpenCheckTest {
     tempFile1.writeText(testContent1)
     tempFile2.writeText(testContent2)
 
-    runScript()
+    val exception = assertThrows<Exception>() { runScript() }
 
-    assertThat(outContent.toString().trim()).isEqualTo(TODO_SYNTAX_CHECK_FAILED_OUTPUT_INDICATOR)
+    assertThat(exception).hasMessageThat().contains(TODO_SYNTAX_CHECK_FAILED_OUTPUT_INDICATOR)
+    val failureMessage =
+      """
+      TODOs not corresponding to open issues on GitHub:
+      - TempFile2.kt:1
+
+      $wikiReferenceNote
+
+      $regenerateNote
+      """.trimIndent()
+    assertThat(outContent.toString().trim()).isEqualTo(failureMessage)
   }
 
   private fun setUpGitHubService(