apostrophecms / docs

ApostropheCMS documentation.
MIT License
4 stars 14 forks source link

minor correction to code example and file location #276

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]" The admin-bar reference page had two problems with the code example for the add(). First, there was a missing closing parenthesis. Second, the file location was incorrect. This PR fixes both. Closes PRO-3438.

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
  1. Build the documentation
  2. Navigate to /reference/modules/admin-bar.html#add-name-label-permission-options

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-3438 Example code for the `add()` in the admin-bar reference is incorrect

The code example is missing a closing parenthesis and so will throw an error. In addition, the directory indicated for the example is incorrect.