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

Improve docs on actions $unique and group parameters #1066

Open
jorgeatorres opened this issue Jun 7, 2024 · 0 comments
Open

Improve docs on actions $unique and group parameters #1066

jorgeatorres opened this issue Jun 7, 2024 · 0 comments
Labels
type: documentation This issue is a request for better documentation.

Comments

@jorgeatorres
Copy link
Member

Despite some improvements to the docblocks themselves, our current documentation doesn't clearly convey what unique actions mean or what the group parameter is for.

This stems from #1065:

as_schedule_single_action() & as_schedule_recurring_action() can accept a $group parameter to group different actions for the one plugin together.

This is a little unclear. What does it mean to "group actions together"? I can't seem to find anything explaining exactly what $group is for.

Edit: Same question with $unique. The documentation doesn't explain what this argument means. I'm guessing that you cannot enqueue a unique task if there is already one scheduled or in-progress?

It'd be nice if the API documentation includes a section explaining the semantics of the arguments.

@jorgeatorres jorgeatorres added the type: documentation This issue is a request for better documentation. label Jun 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: documentation This issue is a request for better documentation.
Projects
None yet
Development

No branches or pull requests

1 participant