docs: rewrite method header

christolis · christolis · commit 1c2c6a5f3afc · 2024-03-16T12:06:14.000+02:00
diff --git a/application/src/main/java/org/togetherjava/tjbot/features/chatgpt/ChatGptService.java b/application/src/main/java/org/togetherjava/tjbot/features/chatgpt/ChatGptService.java
@@ -105,7 +105,7 @@ public Optional<String> ask(String question, String context) {
     }
 
     /**
-     * Prompt ChatGPT with code for it to format it.
+     * Provide ChatGPT with code to format.
      *
      * @param code the code to be formatted by ChatGPT. If code exceeds {@value MAX_CODE_LENGTH}
      *        characters then this method returns an empty {@link Optional}

Original file line number	Diff line number	Diff line change
`@@ -105,7 +105,7 @@ public Optional<String> ask(String question, String context) {`
`105`	`105`	`}`
`106`	`106`
`107`	`107`	`/**`
`108`		`- * Prompt ChatGPT with code for it to format it.`
	`108`	`+ * Provide ChatGPT with code to format.`
`109`	`109`	`*`
`110`	`110`	`* @param code the code to be formatted by ChatGPT. If code exceeds {@value MAX_CODE_LENGTH}`
`111`	`111`	`* characters then this method returns an empty {@link Optional}`