GH Action Documentation

This commit is contained in:
confused-Techie 2023-05-11 22:27:12 +00:00 committed by github-actions[bot]
parent 085c4dc756
commit 89c6392609
2 changed files with 54 additions and 0 deletions

View File

@ -209,6 +209,15 @@ style: Exclusively used for the <code>style</code> attribute</p>
<dd></dd>
</dl>
## Typedefs
<dl>
<dt><a href="#observePaneItemsCallback">observePaneItemsCallback</a> : <code>function</code></dt>
<dd></dd>
<dt><a href="#onDidAddTextEditorCB">onDidAddTextEditorCB</a> : <code>function</code></dt>
<dd></dd>
</dl>
<a name="AtomEnvironment"></a>
## AtomEnvironment
@ -648,3 +657,21 @@ This file aims to run some short simple tests against `update.js`. Focusing
## beforeEach()
**Kind**: global function
**Babel**:
<a name="observePaneItemsCallback"></a>
## observePaneItemsCallback : <code>function</code>
**Kind**: global typedef
| Param | Type | Description |
| --- | --- | --- |
| item | <code>object</code> | An item that is present in {::getPaneItems} at the time of subscription or that is added at some later time. |
<a name="onDidAddTextEditorCB"></a>
## onDidAddTextEditorCB : <code>function</code>
**Kind**: global typedef
**Params**: <code>object</code> event - Object with following keys:
**Params**: <code>TextEditor</code> event.textEditor - The TextEditor that was added.
**Params**: <code>Pane</code> event.pane - Pane containing the added text editor.
**Params**: <code>integer</code> event.index - Number indicating the index of the added text
editor in it's pane.

View File

@ -209,6 +209,15 @@ style: Exclusively used for the <code>style</code> attribute</p>
<dd></dd>
</dl>
## Typedefs
<dl>
<dt><a href="#observePaneItemsCallback">observePaneItemsCallback</a> : <code>function</code></dt>
<dd></dd>
<dt><a href="#onDidAddTextEditorCB">onDidAddTextEditorCB</a> : <code>function</code></dt>
<dd></dd>
</dl>
<a name="AtomEnvironment"></a>
## AtomEnvironment
@ -656,3 +665,21 @@ This file aims to run some short simple tests against `update.js`. Focusing
## beforeEach()
**Kind**: global function
**Babel**:
<a name="observePaneItemsCallback"></a>
## observePaneItemsCallback : <code>function</code>
**Kind**: global typedef
| Param | Type | Description |
| --- | --- | --- |
| item | <code>object</code> | An item that is present in {::getPaneItems} at the time of subscription or that is added at some later time. |
<a name="onDidAddTextEditorCB"></a>
## onDidAddTextEditorCB : <code>function</code>
**Kind**: global typedef
**Params**: <code>object</code> event - Object with following keys:
**Params**: <code>TextEditor</code> event.textEditor - The TextEditor that was added.
**Params**: <code>Pane</code> event.pane - Pane containing the added text editor.
**Params**: <code>integer</code> event.index - Number indicating the index of the added text
editor in it's pane.