Merge pull request #32 from gitbito/prompt-update-1

bitoandy · web-flow · commit 15c728149149 · 2024-05-11T14:57:15.000-07:00
Updated prompt in structured_doc.txt. Works best in ADVANCED models
diff --git a/documentation/create_code_doc/prompts/structured_doc.txt b/documentation/create_code_doc/prompts/structured_doc.txt
@@ -32,5 +32,5 @@ This is particularly helpful for libraries or tools meant to be used by other de
 
 -When documenting, aim for clarity, brevity, and completeness. Remember, the primary goal is to make the code as understandable and usable as possible for anyone who encounters it in the future.
 
-Using the guidelines above create documentation for code provided below without mentioning any of the guidelines above in documentation and only include required sections in documentation, never have empty sections:
+Using the guidelines above create documentation for code provided below without mentioning any of the guidelines above in documentation and only include required sections in documentation, never have empty sections. The output should be markdown, without markdown code block that can be directly used without any changes and any additional content:
 

Original file line number	Diff line number	Diff line change
`@@ -32,5 +32,5 @@ This is particularly helpful for libraries or tools meant to be used by other de`
`32`	`32`
`33`	`33`	`-When documenting, aim for clarity, brevity, and completeness. Remember, the primary goal is to make the code as understandable and usable as possible for anyone who encounters it in the future.`
`34`	`34`
`35`		`-Using the guidelines above create documentation for code provided below without mentioning any of the guidelines above in documentation and only include required sections in documentation, never have empty sections:`
	`35`	`+Using the guidelines above create documentation for code provided below without mentioning any of the guidelines above in documentation and only include required sections in documentation, never have empty sections. The output should be markdown, without markdown code block that can be directly used without any changes and any additional content:`
`36`	`36`