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.

Sign up for GitHub

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

Marking internal action as @ignore to remove them from the documentation. #42163

Merged
merged 5 commits into from
Jul 21, 2022
Merged

Marking internal action as @ignore to remove them from the documentation. #42163

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
b279bac
Marking internal action as @private to remove them from the documenta…
ryanwelcher Jul 5, 2022
646d6a0
Merge branch 'trunk' into try/excluding-internal-actions-from-docs
ryanwelcher Jul 20, 2022
bce95d7
Use @ignore as per docblock standards.
ryanwelcher Jul 20, 2022
5de8fa1
Adds a reason to the @ignore tag for internal actions.
ryanwelcher Jul 21, 2022
a1275ac
Revert jsdoc config change. Add the reason for being ignored into the…
ryanwelcher Jul 21, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
79 changes: 0 additions & 79 deletions docs/reference-guides/data/data-core.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -611,58 +611,6 @@ _Returns_

- `Object`: Action object.

### receiveAutosaves

Returns an action object used in signalling that the autosaves for a
post have been received.

_Parameters_

- _postId_ `number`: The id of the post that is parent to the autosave.
- _autosaves_ `Array|Object`: An array of autosaves or singular autosave object.

_Returns_

- `Object`: Action object.

### receiveCurrentTheme

Returns an action object used in signalling that the current theme has been received.

_Parameters_

- _currentTheme_ `Object`: The current theme.

_Returns_

- `Object`: Action object.

### receiveCurrentUser

Returns an action used in signalling that the current user has been received.

_Parameters_

- _currentUser_ `Object`: Current user object.

_Returns_

- `Object`: Action object.

### receiveEmbedPreview

Returns an action object used in signalling that the preview data for
a given URl has been received.

_Parameters_

- _url_ `string`: URL to preview the embed for.
- _preview_ `*`: Preview data.

_Returns_

- `Object`: Action object.

### receiveEntityRecords

Returns an action object used in signalling that entity records have been received.
Expand Down Expand Up @@ -704,33 +652,6 @@ _Returns_

- `Object`: Action object.

### receiveUserPermission

Returns an action object used in signalling that the current user has
permission to perform an action on a REST resource.

_Parameters_

- _key_ `string`: A key that represents the action and REST resource.
- _isAllowed_ `boolean`: Whether or not the user can perform the action.

_Returns_

- `Object`: Action object.

### receiveUserQuery

Returns an action object used in signalling that authors have been received.

_Parameters_

- _queryID_ `string`: Query ID.
- _users_ `Array|Object`: Users received.

_Returns_

- `Object`: Action object.

### redo

Action triggered to redo the last undoed
Expand Down
79 changes: 0 additions & 79 deletions packages/core-data/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,58 +90,6 @@ _Returns_

- `Object`: Action object.

### receiveAutosaves
Copy link
Member

Choose a reason for hiding this comment

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

It looks like we print the same content in @wordpress/core-data's README file. Should we link to the reference gude instead?


Returns an action object used in signalling that the autosaves for a
post have been received.

_Parameters_

- _postId_ `number`: The id of the post that is parent to the autosave.
- _autosaves_ `Array|Object`: An array of autosaves or singular autosave object.

_Returns_

- `Object`: Action object.

### receiveCurrentTheme

Returns an action object used in signalling that the current theme has been received.

_Parameters_

- _currentTheme_ `Object`: The current theme.

_Returns_

- `Object`: Action object.

### receiveCurrentUser

Returns an action used in signalling that the current user has been received.

_Parameters_

- _currentUser_ `Object`: Current user object.

_Returns_

- `Object`: Action object.

### receiveEmbedPreview

Returns an action object used in signalling that the preview data for
a given URl has been received.

_Parameters_

- _url_ `string`: URL to preview the embed for.
- _preview_ `*`: Preview data.

_Returns_

- `Object`: Action object.

### receiveEntityRecords

Returns an action object used in signalling that entity records have been received.
Expand Down Expand Up @@ -183,33 +131,6 @@ _Returns_

- `Object`: Action object.

### receiveUserPermission

Returns an action object used in signalling that the current user has
permission to perform an action on a REST resource.

_Parameters_

- _key_ `string`: A key that represents the action and REST resource.
- _isAllowed_ `boolean`: Whether or not the user can perform the action.

_Returns_

- `Object`: Action object.

### receiveUserQuery

Returns an action object used in signalling that authors have been received.

_Parameters_

- _queryID_ `string`: Query ID.
- _users_ `Array|Object`: Users received.

_Returns_

- `Object`: Action object.

### redo

Action triggered to redo the last undoed
Expand Down
27 changes: 27 additions & 0 deletions packages/core-data/src/actions.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,9 @@ import { STORE_NAME } from './name';

/**
* Returns an action object used in signalling that authors have been received.
* Ignored from documentation as it's internal to the data store.
*
* @ignore
*
* @param {string} queryID Query ID.
* @param {Array|Object} users Users received.
Expand All @@ -37,6 +40,9 @@ export function receiveUserQuery( queryID, users ) {

/**
* Returns an action used in signalling that the current user has been received.
* Ignored from documentation as it's internal to the data store.
*
* @ignore
*
* @param {Object} currentUser Current user object.
*
Expand Down Expand Up @@ -106,6 +112,9 @@ export function receiveEntityRecords(

/**
* Returns an action object used in signalling that the current theme has been received.
* Ignored from documentation as it's internal to the data store.
*
* @ignore
*
* @param {Object} currentTheme The current theme.
*
Expand All @@ -120,6 +129,9 @@ export function receiveCurrentTheme( currentTheme ) {

/**
* Returns an action object used in signalling that the current global styles id has been received.
* Ignored from documentation as it's internal to the data store.
*
* @ignore
*
* @param {string} currentGlobalStylesId The current global styles id.
*
Expand All @@ -136,6 +148,9 @@ export function __experimentalReceiveCurrentGlobalStylesId(

/**
* Returns an action object used in signalling that the theme base global styles have been received
* Ignored from documentation as it's internal to the data store.
*
* @ignore
*
* @param {string} stylesheet The theme's identifier
* @param {Object} globalStyles The global styles object.
Expand All @@ -155,6 +170,9 @@ export function __experimentalReceiveThemeBaseGlobalStyles(

/**
* Returns an action object used in signalling that the theme global styles variations have been received.
* Ignored from documentation as it's internal to the data store.
*
* @ignore
*
* @param {string} stylesheet The theme's identifier
* @param {Array} variations The global styles variations.
Expand Down Expand Up @@ -192,6 +210,9 @@ export function receiveThemeSupports() {
/**
* Returns an action object used in signalling that the preview data for
* a given URl has been received.
* Ignored from documentation as it's internal to the data store.
*
* @ignore
*
* @param {string} url URL to preview the embed for.
* @param {*} preview Preview data.
Expand Down Expand Up @@ -766,6 +787,9 @@ export function receiveUploadPermissions( hasUploadPermissions ) {
/**
* Returns an action object used in signalling that the current user has
* permission to perform an action on a REST resource.
* Ignored from documentation as it's internal to the data store.
*
* @ignore
*
* @param {string} key A key that represents the action and REST resource.
* @param {boolean} isAllowed Whether or not the user can perform the action.
Expand All @@ -783,6 +807,9 @@ export function receiveUserPermission( key, isAllowed ) {
/**
* Returns an action object used in signalling that the autosaves for a
* post have been received.
* Ignored from documentation as it's internal to the data store.
*
* @ignore
*
* @param {number} postId The id of the post that is parent to the autosave.
* @param {Array|Object} autosaves An array of autosaves or singular autosave object.
Expand Down