Skip to content

Commit 1b374de

Browse files
committed
fix(doc): update doc by experience
1 parent 7a70f8b commit 1b374de

File tree

2 files changed

+2
-2
lines changed

2 files changed

+2
-2
lines changed

kotlin/src/main/kotlin/cc/unitmesh/kotlin/provider/KotlinLivingDocumentation.kt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ class KotlinLivingDocumentation : LivingDocumentation {
5757
}
5858

5959
override val forbiddenRules: List<String> = listOf(
60-
"do not return code, just documentation.",
60+
"do not return any code, just documentation.",
6161
"do not use @author and @version tags."
6262
)
6363

src/main/kotlin/cc/unitmesh/devti/intentions/action/task/LivingDocPromptBuilder.kt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@ open class LivingDocPromptBuilder(
116116
val startEndString = documentation.startEndString(type)
117117
instruction.append(documentation.forbiddenRules.joinToString { "\n- $it" })
118118

119-
instruction.append("\n\nStart your documentation with ${startEndString.first} here, and ends with `${startEndString.second}`.\n")
119+
instruction.append("\n\nStart your documentation with ${startEndString.first} here, no code, and ends with `${startEndString.second}`.\n")
120120
instruction.toString()
121121
}
122122
}

0 commit comments

Comments
 (0)