Skip to content

Commit 7adaf07

Browse files
Ask LLM to review documentation with more welcoming tone #82
1 parent 7764b74 commit 7adaf07

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

tools/review_file/review_file.py

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,9 @@ def run_llm_review(
9696
f"All legal obligations and rights must remain exactly as written.\n"
9797
f"6. Edit the text directly to enhance readability and technical accuracy.\n"
9898
f"7. Preserve the original meaning and intent of the content.\n"
99-
f"8. Ensure consistency in terminology, tone, and technical details across README files, code comments, and markdown sections.\n\n"
99+
f"8. Ensure consistency in terminology, tone, and technical details across README files, code comments, and markdown sections.\n"
100+
f"9. The documentation is intended for public users, please retain or add polite, friendly wording "
101+
f"such as 'please' where appropriate to maintain a welcoming tone.\n\n"
100102
f"{user_instructions_prompt}"
101103
f"Output:\n"
102104
f"Return the **entire revised content** as a plain text, without additional commentary or formatting.\n"

0 commit comments

Comments
 (0)