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

[Documentation Update] Updating Using and Creating Abilities to use Action Annotations #6653

Merged
merged 1 commit into from
Jan 2, 2024

Conversation

himsmittal
Copy link

@himsmittal himsmittal commented Jan 2, 2024

Background

Using and Creating Abilities is referring to @ability decorator for creating custom abilities. This needs to be updated to use the @action decorator and corresponding classes.

Changes 🏗️

Update the documentation to use the ActionRegister class and @action annotation
closes #6652

PR Quality Scorecard ✨

  • Have you used the PR description template?   +2 pts
  • Is your pull request atomic, focusing on a single change?   +5 pts
  • [x ] Have you linked the GitHub issue(s) that this PR addresses?   +5 pts ([Documentation] Using and Creating Abilities doc needs to be updated to use @action annotation #6652)
  • [x ] Have you documented your changes clearly and comprehensively?   +5 pts
  • Have you changed or added a feature?   -4 pts
    • Have you added/updated corresponding documentation?   +4 pts
    • Have you added/updated corresponding integration tests?   +5 pts
  • Have you changed the behavior of AutoGPT?   -5 pts
    • Have you also run agbenchmark to verify that these changes do not regress performance?   +10 pts

@himsmittal himsmittal requested a review from Swiftyos as a code owner January 2, 2024 07:05
@github-actions github-actions bot added the size/m label Jan 2, 2024
Copy link

netlify bot commented Jan 2, 2024

Deploy Preview for auto-gpt-docs ready!

Name Link
🔨 Latest commit 5e7cde1
🔍 Latest deploy log https://app.netlify.com/sites/auto-gpt-docs/deploys/6593b5a14c31ff00083e086e
😎 Deploy Preview https://deploy-preview-6653--auto-gpt-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link
Contributor

@Swiftyos Swiftyos left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for updating this

@Swiftyos Swiftyos merged commit b8238c2 into Significant-Gravitas:master Jan 2, 2024
6 checks passed
@himsmittal
Copy link
Author

himsmittal commented Jan 2, 2024

@Swiftyos Thanks for the approval.
There are code references that use the word ability (example ) for actions. if the direction is to rename abilities to actions, then it would be better to have consistency in code for better useability. If you feel this is correct, I can raise the PR with those changes.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

[Documentation] Using and Creating Abilities doc needs to be updated to use @action annotation
3 participants