Open
Conversation
This commit adds a comprehensive prompt for generating Doxygen-style documentation for Python code. Doxygen is a documentation generator that extracts structured comments from code to create reference documentation. The AI Agent with this prompt does the following: - Implements the ## comment style specifically for Python - Defines documentation structures for functions, classes, and modules - Provides templates for @brief summaries, parameter descriptions, return values, and exceptions - Includes guidelines for documenting class variables and instance variables - Outlines a 4-step documentation process: code analysis, critical elements, quality writing, and consistency - Emphasizes explaining the "why" behind code, not just functionality - Includes examples of proper @code usage for demonstrating implementation
Contributor
pablo-forgood-ai
left a comment
There was a problem hiding this comment.
I cannot approve this PR in its current state due to a syntax error in the DoxyGen Docs Generator configuration file.
On line 6, there's a missing closing quotation mark in the "File Search" tool entry:
"File Search,
Contributor
|
Also make the file ".json" |
Author
|
Hello @pablo-forgood-ai - thank you for your review on this one as well. As with the previous one, the changes have been made. Please review and check again when you catch a moment. |
Contributor
pablo-forgood-ai
left a comment
There was a problem hiding this comment.
Thank you.
Please correct these tool names:
Semantic Code Search -> (does not exist?)
Full Text Search -> full_text_search
File Search -> file_search
Fetch -> webpage_content
File Editor -> file_edit
Thanks a lot in advance
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This commit adds a comprehensive prompt for generating Doxygen-style documentation for Python code. Doxygen is a documentation generator that extracts structured comments from code to create reference documentation.
The AI Agent with this prompt does the following: