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

Update docs for version 3.0 #414

Merged
merged 4 commits into from
Jan 14, 2020
Merged

Update docs for version 3.0 #414

merged 4 commits into from
Jan 14, 2020

Conversation

thenbrent
Copy link
Contributor

  • remove references to CPT usage (incl. comments table for logs)
  • update Perf guide to provide warnings
  • add doc for as_enqueue_async_action()
  • add doc for as_unschedule_all_actions()
  • mention async actions in doc (needs more detail)

Fixes #411

@thenbrent thenbrent changed the title Update docs for AS 3.0 Update docs for version 3.0 Jan 9, 2020
Copy link
Contributor

@rrennick rrennick left a comment

Choose a reason for hiding this comment

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

@thenbrent Thanks for updating this. This looks great other than the two item I notes so I'm pre-approving.

docs/api.md Outdated
### Usage

```php
as_enqueue_async_action( $hook, $hook, $args, $group )
Copy link
Contributor

Choose a reason for hiding this comment

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

$hook parameter is duplicated.

docs/index.md Outdated

### Housekeeping

Before processing a batch, the scheduler will remove any existing claims on actions which have been sitting in a queue for more than five minutes.
Before processing a batch, the scheduler will remove any existing claims on actions which have been sitting in a queue for more than five minutes (or more specifically, 10 times the allowed time limit, which defaults to 30 seconds).

Action Scheduler will also trash any actions which were completed more than a month ago.
Copy link
Contributor

Choose a reason for hiding this comment

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

were completed or canceled more than a month ago

@thenbrent
Copy link
Contributor Author

I've fixed both of those up. Thanks for the review @rrennick.

@thenbrent thenbrent merged commit 3847b7c into master Jan 14, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update docs/*.md for v3.0
2 participants