Add Docstrings to swarm_daddy.py and agent_system_prompts.py #25
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.
PR Feedback (click)
I created this PR to address this rule:
"Add docstrings to all functions and file headers."
Description
This PR adds docstrings to all functions and file headers in the files
swarm_daddy.py
andagent_system_prompts.py
. The docstrings provide clear and concise explanations of the purpose and functionality of the code, improving code readability and maintainability.The docstrings adhere to the Google Python docstring style as mentioned in the
CONTRIBUTING.md
file.Summary of Changes
swarm_daddy.py
andagent_system_prompts.py
explaining the purpose of the file and any important details about its contents.swarm_daddy.py
(AGENT_ROLE_IDENTIFICATION_AGENT_PROMPT
,AGENT_CONFIGURATION_AGENT_PROMPT
,SWARM_ASSEMBLY_AGENT_PROMPT
,TESTING_OPTIMIZATION_AGENT_PROMPT
) explaining its purpose and usage.agent_system_prompts.py
(autonomous_agent_prompt
,agent_system_prompt_2
) explaining its purpose, its arguments, and its return values.AGENT_SYSTEM_PROMPT_3
inagent_system_prompts.py
explaining its purpose and usage.