Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Docstrings to swarm_daddy.py and agent_system_prompts.py #25

Closed
wants to merge 2 commits into from

Conversation

sweep-ai[bot]
Copy link

@sweep-ai sweep-ai bot commented Dec 15, 2023

PR Feedback (click)

  • 👍 Sweep Did Well
  • 👎 Sweep Needs Improvement

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 and agent_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

  • Added a docstring at the top of swarm_daddy.py and agent_system_prompts.py explaining the purpose of the file and any important details about its contents.
  • Added docstrings to each constant defined in 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.
  • Added docstrings to each function defined in agent_system_prompts.py (autonomous_agent_prompt, agent_system_prompt_2) explaining its purpose, its arguments, and its return values.
  • Added a docstring to the constant AGENT_SYSTEM_PROMPT_3 in agent_system_prompts.py explaining its purpose and usage.

Copy link
Author

sweep-ai bot commented Dec 15, 2023

Rollback Files For Sweep

  • Rollback changes to swarms/prompts/swarm_daddy.py
  • Rollback changes to swarms/prompts/swarm_daddy.py
  • Rollback changes to swarms/prompts/agent_system_prompts.py
  • Rollback changes to swarms/prompts/agent_system_prompts.py

@sweep-ai sweep-ai bot added the sweep label Dec 15, 2023
Copy link
Author

sweep-ai bot commented Dec 15, 2023

Sandbox Executions

  • Running GitHub Actions for swarms/prompts/swarm_daddy.py
Check swarms/prompts/swarm_daddy.py with contents:

Ran GitHub Actions for 3c6aee3332871ba22a2ea812479dff5176d1cd42:

  • Running GitHub Actions for swarms/prompts/agent_system_prompts.py
Check swarms/prompts/agent_system_prompts.py with contents:

Ran GitHub Actions for 18cc412b3eda53c795ce410d64539052a03e12be:

@sweep-ai sweep-ai bot mentioned this pull request Dec 15, 2023
Copy link

Stale pull request message

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant