Skip to content

Commit

Permalink
Update output format for the return value
Browse files Browse the repository at this point in the history
  • Loading branch information
gziolo committed Mar 5, 2019
1 parent 4689fea commit 116d80b
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 20 deletions.
2 changes: 1 addition & 1 deletion packages/docgen/src/markdown/formatter.js
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ module.exports = function( rootDir, docPath, symbols, headingTitle, headingStart
formatTag(
'Returns',
getTagsByName( symbol.tags, 'return' ),
( tag ) => `\n\`${ tag.type }\` ${ cleanSpaces( tag.description ) }`,
( tag ) => `\n\`${ tag.type }\`: ${ cleanSpaces( tag.description ) }`,
docs
);
docs.push( '\n' );
Expand Down
38 changes: 19 additions & 19 deletions packages/e2e-test-utils/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Verifies if publish checks are enabled.

**Returns**

`boolean` Boolean which represents the state of prepublish checks.
`boolean`: Boolean which represents the state of prepublish checks.

### clearLocalStorage

Expand Down Expand Up @@ -88,7 +88,7 @@ Creates a function to determine if a request is embedding a certain URL.

**Returns**

`function` Function that determines if a request is for the embed API, embedding a specific URL.
`function`: Function that determines if a request is for the embed API, embedding a specific URL.

### createJSONResponse

Expand All @@ -102,7 +102,7 @@ Respond to a request with a JSON response.

**Returns**

`Promise` Promise that responds to a request with the mock JSON response.
`Promise`: Promise that responds to a request with the mock JSON response.

### createNewPost

Expand All @@ -127,7 +127,7 @@ Creates new URL by parsing base URL, WPPath and query string.

**Returns**

`string` String which represents full URL.
`string`: String which represents full URL.

### createURLMatcher

Expand All @@ -141,7 +141,7 @@ Creates a function to determine if a request is calling a URL with the substring

**Returns**

`function` Function that determines if a request's URL contains substring.
`function`: Function that determines if a request's URL contains substring.

### deactivatePlugin

Expand Down Expand Up @@ -180,7 +180,7 @@ Verifies that the edit post sidebar is opened, and if it is not, opens it.

**Returns**

`Promise` Promise resolving once the edit post sidebar is opened.
`Promise`: Promise resolving once the edit post sidebar is opened.

### findSidebarPanelToggleButtonWithTitle

Expand All @@ -194,7 +194,7 @@ Finds a sidebar panel with the provided title.

**Returns**

`?ElementHandle` Object that represents an in-page DOM element.
`?ElementHandle`: Object that represents an in-page DOM element.

### findSidebarPanelWithTitle

Expand All @@ -208,7 +208,7 @@ Finds the button responsible for toggling the sidebar panel with the provided ti

**Returns**

`?ElementHandle` Object that represents an in-page DOM element.
`?ElementHandle`: Object that represents an in-page DOM element.

### getAllBlocks

Expand All @@ -218,7 +218,7 @@ Returns an array with all blocks; Equivalent to calling wp.data.select( 'core/ed

**Returns**

`Promise` Promise resolving with an array containing all blocks in the document.
`Promise`: Promise resolving with an array containing all blocks in the document.

### getAvailableBlockTransforms

Expand All @@ -229,7 +229,7 @@ that the current selected block can be transformed into.

**Returns**

`Promise` Promise resolving with an array containing all possible block transforms
`Promise`: Promise resolving with an array containing all possible block transforms

### getEditedPostContent

Expand All @@ -239,7 +239,7 @@ Returns a promise which resolves with the edited post content (HTML string).

**Returns**

`Promise` Promise resolving with post content markup.
`Promise`: Promise resolving with post content markup.

### hasBlockSwitcher

Expand All @@ -249,7 +249,7 @@ Returns a boolean indicating if the current selected block has a block switcher

**Returns**

`Promise` Promise resolving with a boolean.
`Promise`: Promise resolving with a boolean.

### insertBlock

Expand Down Expand Up @@ -287,7 +287,7 @@ Checks if current URL is a WordPress path.

**Returns**

`boolean` Boolean represents whether current URL is or not a WordPress path.
`boolean`: Boolean represents whether current URL is or not a WordPress path.

### loginUser

Expand Down Expand Up @@ -315,7 +315,7 @@ deserialised JSON response for the request.

**Returns**

`Promise` Promise that uses `mockCheck` to see if a request should be mocked with `mock`, and optionally transforms the response with `responseObjectTransform`.
`Promise`: Promise that uses `mockCheck` to see if a request should be mocked with `mock`, and optionally transforms the response with `responseObjectTransform`.

### observeFocusLoss

Expand Down Expand Up @@ -349,7 +349,7 @@ Presses the given keyboard key a number of times in sequence.

**Returns**

`Promise` Promise resolving when key presses complete.
`Promise`: Promise resolving when key presses complete.

### pressKeyWithModifier

Expand All @@ -372,7 +372,7 @@ is displayed).

**Returns**

`Promise` Promise resolving when publish is complete.
`Promise`: Promise resolving when publish is complete.

### publishPostWithPrePublishChecksDisabled

Expand All @@ -383,7 +383,7 @@ resolving once the request is complete (once a notice is displayed).

**Returns**

`Promise` Promise resolving when publish is complete.
`Promise`: Promise resolving when publish is complete.

### saveDraft

Expand All @@ -394,7 +394,7 @@ Saves the post as a draft, resolving once the request is complete (once the

**Returns**

`Promise` Promise resolving when draft save is complete.
`Promise`: Promise resolving when draft save is complete.

### searchForBlock

Expand Down Expand Up @@ -438,7 +438,7 @@ Sets code editor content

**Returns**

`Promise` Promise resolving with an array containing all blocks in the document.
`Promise`: Promise resolving with an array containing all blocks in the document.

### setUpResponseMocking

Expand Down

0 comments on commit 116d80b

Please sign in to comment.