Skip to content

Commit

Permalink
updates some comments
Browse files Browse the repository at this point in the history
also removes cruft from a test
  • Loading branch information
draganescu committed Jun 2, 2020
1 parent e4849f5 commit 12720bf
Show file tree
Hide file tree
Showing 5 changed files with 6 additions and 7 deletions.
2 changes: 1 addition & 1 deletion docs/designers-developers/developers/data/data-core.md
Original file line number Diff line number Diff line change
Expand Up @@ -479,7 +479,7 @@ _Parameters_

- _kind_ `string`: Kind of the deleted entity.
- _name_ `string`: Name of the deleted entity.
- _recordId_ `Object`: Record to be deleted.
- _recordId_ `string`: Record Id of the entity to be deleted.

<a name="editEntityRecord" href="#editEntityRecord">#</a> **editEntityRecord**

Expand Down
2 changes: 1 addition & 1 deletion packages/core-data/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ _Parameters_

- _kind_ `string`: Kind of the deleted entity.
- _name_ `string`: Name of the deleted entity.
- _recordId_ `Object`: Record to be deleted.
- _recordId_ `string`: Record Id of the entity to be deleted.

<a name="editEntityRecord" href="#editEntityRecord">#</a> **editEntityRecord**

Expand Down
2 changes: 1 addition & 1 deletion packages/core-data/src/actions.js
Original file line number Diff line number Diff line change
Expand Up @@ -144,7 +144,7 @@ export function receiveEmbedPreview( url, preview ) {
*
* @param {string} kind Kind of the deleted entity.
* @param {string} name Name of the deleted entity.
* @param {Object} recordId Record to be deleted.
* @param {string} recordId Record Id of the entity to be deleted.
*/
export function* deleteEntityRecord( kind, name, recordId ) {
const entities = yield getKindEntities( kind );
Expand Down
6 changes: 3 additions & 3 deletions packages/core-data/src/queried-data/actions.js
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,10 @@ export function receiveItems( items ) {

/**
* Returns an action object used in signalling that entity records have been
* deleted and it needs to be removed from entities state.
* deleted and they need to be removed from entities state.
*
* @param {string} kind Kind of the removed entity.
* @param {string} name Name of the removed entity.
* @param {string} kind Kind of the removed entities.
* @param {string} name Name of the removed entities.
* @param {Array|Object} records Records removed.
* @return {Object} Action object.
*/
Expand Down
1 change: 0 additions & 1 deletion packages/core-data/src/queried-data/test/reducer.js
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,6 @@ describe( 'reducer', () => {
} );
const state = reducer( original, {
type: 'REMOVE_ITEMS',
query: [ 3 ],
items: [ 3 ],
} );

Expand Down

0 comments on commit 12720bf

Please sign in to comment.