apostrophecms / docs

ApostropheCMS documentation.
MIT License
4 stars 14 forks source link

adds runPlayers documentation #318

Closed BoDonkey closed 1 year ago

BoDonkey commented 1 year ago

Summary

Summarize the changes briefly, including which issue/ticket this resolves. If it closes an existing Github issue, include "Closes #[issue number]" This PR adds in a description of the @apostrophecms/util module runPlayers() function. Closes PRO-4119.

What are the specific steps to test this change?

For example:

  1. Run the website and log in as an admin
  2. Open a piece manager modal and select several pieces
  3. Click the "Archive" button on the top left of the manager and confirm that it should proceed
  4. Check that all pieces have been archived properly
  5. Build the documentation
  6. Navigate to /reference/modules/util.html#runplayers-el

What kind of change does this PR introduce?

(Check at least one)

Make sure the PR fulfills these requirements:

If adding a new feature without an already open issue, it's best to open a feature request issue first and wait for approval before working on it.

Other information:

linear[bot] commented 1 year ago
PRO-4119 Add documentation for `apos.util.runPlayers`

In ticket [PRO-4117](https://linear.app/apostrophecms/issue/PRO-4117/apostrophecmsvideo-not-working-correctly-within-other-custom-widget), Tom points out that the `apostrophecms/util` module has a helper function `runPlayers` that lacks documentation. In looking at the provided comment block, it seems that `widgetPlayers` is also undocumented.