Skip to content

Commit 921e790

Browse files
zlovattzlovatt
committed
Rename Argument header in tables to Parameter
1 parent 897092a commit 921e790

File tree

16 files changed

+170
-170
lines changed

16 files changed

+170
-170
lines changed

‎docs/application/application.md‎

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -441,9 +441,9 @@ Determines whether the file at path can be opened as a Premiere Pro [project](..
441441

442442
#### Parameters
443443

444-
| Argument | Type | Description |
445-
| -------- | ------ | ----------------- |
446-
| `path` | String | A path to a file. |
444+
| Parameter | Type | Description |
445+
| --------- | ------ | ----------------- |
446+
| `path` | String | A path to a file. |
447447

448448
#### Returns
449449

@@ -490,9 +490,9 @@ Creates a new .prproj [Project object](../general/project.md), at the specified
490490

491491
#### Parameters
492492

493-
| Argument | Type | Description |
494-
| -------- | ------ | -------------------------------------------------------------------- |
495-
| `path` | String | A full path to new project; a .prproj extension will *not* be added. |
493+
| Parameter | Type | Description |
494+
| --------- | ------ | -------------------------------------------------------------------- |
495+
| `path` | String | A full path to new project; a .prproj extension will *not* be added. |
496496

497497
#### Returns
498498

@@ -510,7 +510,7 @@ Opens the file at the specified path, as a Premiere Pro [Project object](../gene
510510

511511
#### Parameters
512512

513-
| Argument | Type | Description |
513+
| Parameter | Type | Description |
514514
| -------------------------- | ------- | --------------------------------------------------------------- |
515515
| `path` | String | Full path to the document to be opened. |
516516
| `suppressConversionDialog` | Boolean | Optional. Suppress project conversion dialog. |
@@ -534,7 +534,7 @@ Opens an FCP XML file as a Premiere Pro [Project object](../general/project.md)
534534

535535
#### Parameters
536536

537-
| Argument | Type | Description |
537+
| Parameter | Type | Description |
538538
| ---------- | ------ | ----------- |
539539
| `path` | String | |
540540
| `projPath` | String | |
@@ -573,7 +573,7 @@ Determines whether proxy usage is currently enabled.
573573

574574
#### Parameters
575575

576-
| Argument | Type | Description |
576+
| Parameter | Type | Description |
577577
| --------- | ------- | ----------------------------------------- |
578578
| `enabled` | Integer | `1` turns proxies on, `0` turns them off. |
579579

@@ -593,7 +593,7 @@ Whether extension with the given extensionID persists, within this session.
593593

594594
#### Parameters
595595

596-
| Argument | Type | Description |
596+
| Parameter | Type | Description |
597597
| ------------- | ------- | ------------------------------------------------------------- |
598598
| `extensionID` | String | Which extension to modify. |
599599
| `persistent` | Integer | Pass `1` to keep extension in memory, `0` to allow unloading. |
@@ -625,7 +625,7 @@ Specifies the path to be used for one of Premiere Pro's scratch disk paths.
625625

626626
#### Parameters
627627

628-
| Argument | Type | Description |
628+
| Parameter | Type | Description |
629629
| ----------------- | ---------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
630630
| `path` | String | The new path to be used. |
631631
| `scratchDiskType` | `ScratchDiskType` enum | Enumerated value, must be one of the following:<ul><li>`ScratchDiskType.FirstVideoCaptureFolder`</li><li>`ScratchDiskType.FirstAudioCaptureFolder`</li><li>`ScratchDiskType.FirstVideoPreviewFolder`</li><li>`ScratchDiskType.FirstAudioPreviewFolder`</li><li>`ScratchDiskType.FirstAutoSaveFolder`</li><li>`ScratchDiskType.FirstCCLibrariesFolder`</li><li>`ScratchDiskType.FirstCapsuleMediaFolder`</li></ul> |
@@ -655,7 +655,7 @@ Writes a string to Premiere Pro's Events panel.
655655

656656
#### Parameters
657657

658-
| Argument | Type | Description |
658+
| Parameter | Type | Description |
659659
| ----------- | ------ | ---------------------------------------------------------------------------- |
660660
| `message` | String | A message to display. |
661661
| `decorator` | String | Decorator, one of:<ul><li>`info`</li><li>`warning`</li><li>`error`</li></ul> |
@@ -676,7 +676,7 @@ Set workspace as active. Use [app.getWorkspaces()](#appgetworkspaces) to get a l
676676

677677
#### Parameters
678678

679-
| Argument | Type | Description |
679+
| Parameter | Type | Description |
680680
| ----------- | ------ | -------------------------- |
681681
| `workspace` | String | The name of the workspace. |
682682

‎docs/collection/markercollection.md‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -46,9 +46,9 @@ Create a new [Marker object](../general/marker.md) on a project item or a sequen
4646

4747
#### Parameters
4848

49-
| Argument | Type | Description |
50-
| -------- | ----- | --------------------------------------------------- |
51-
| `time` | Float | A time, in seconds, where marker should be created. |
49+
| Parameter | Type | Description |
50+
| --------- | ----- | --------------------------------------------------- |
51+
| `time` | Float | A time, in seconds, where marker should be created. |
5252

5353
#### Returns
5454

@@ -69,9 +69,9 @@ Remove a given marker object from a collection.
6969

7070
#### Parameters
7171

72-
| Argument | Type | Description |
73-
| -------- | ------------------------------------- | ------------------------------------------ |
74-
| `marker` | [Marker object](../general/marker.md) | A marker object to remove from collection. |
72+
| Parameter | Type | Description |
73+
| --------- | ------------------------------------- | ------------------------------------------ |
74+
| `marker` | [Marker object](../general/marker.md) | A marker object to remove from collection. |
7575

7676
#### Returns
7777

@@ -151,7 +151,7 @@ Get the next available marker, sorted by seconds, starting from a given one.
151151

152152
#### Parameters
153153

154-
| Argument | Type | Description |
154+
| Parameter | Type | Description |
155155
| --------------- | ------------------------------------- | ------------------------------------------------------- |
156156
| `currentMarker` | [Marker object](../general/marker.md) | A starting marker object, from which to get a next one. |
157157

@@ -174,7 +174,7 @@ Get the previous available marker, sorted by seconds, starting from a given one.
174174

175175
#### Parameters
176176

177-
| Argument | Type | Description |
177+
| Parameter | Type | Description |
178178
| --------------- | ------------------------------------- | ----------------------------------------------------------- |
179179
| `currentMarker` | [Marker object](../general/marker.md) | A starting marker object, from which to get a previous one. |
180180

‎docs/general/anywhere.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -134,7 +134,7 @@ Opens the production at the specified URL.
134134

135135
#### Parameters
136136

137-
| Argument | Type | Description |
137+
| Parameter | Type | Description |
138138
| --------------- | ------ | ---------------------------------- |
139139
| `productionURL` | String | The url of the production to open. |
140140

@@ -154,7 +154,7 @@ Logs the specified email address into the server, using the provided token.
154154

155155
#### Parameters
156156

157-
| Argument | Type | Description |
157+
| Parameter | Type | Description |
158158
| -------------- | ------ | ----------------------------- |
159159
| `token` | String | An authorization token. |
160160
| `emailAddress` | String | The associated email address. |

‎docs/general/encoder.md‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Makes Adobe Media Encoder render (optionally, a specified range from) the specif
2929

3030
#### Parameters
3131

32-
| Argument | Type | Description |
32+
| Parameter | Type | Description |
3333
| ---------------------- | ------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |
3434
| `filePath` | String | A path to a file to render. |
3535
| `outputPath` | String | A path to an output file. |
@@ -55,7 +55,7 @@ Makes Adobe Media Encoder render (optionally, a specified range from) the specif
5555

5656
#### Parameters
5757

58-
| Argument | Type | Description |
58+
| Parameter | Type | Description |
5959
| ---------------------- | -------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |
6060
| `projectItem` | [ProjectItem object](../item/projectitem.md) | A project item to render. |
6161
| `outputPath` | String | A path to an output file. |
@@ -79,13 +79,13 @@ Makes Adobe Media Encoder render the specified [Sequence object](../sequence/seq
7979

8080
#### Parameters
8181

82-
| Argument | Type | Description |
83-
| ---------------------- | ------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------- |
84-
| `sequence` | [Sequence object](../sequence/sequence.md) | A sequence to render. |
85-
| `outputPath` | String | A path to an output file. |
86-
| `presetPath` | String | A path to a preset (.epr) file. |
87-
| `workArea` | Integer | Integer denoting work area to be used:<ul><li>`0` - `ENCODE_ENTIRE`</li><li>`1` - `ENCODE_IN_TO_OUT`</li><li>`2` - `ENCODE_WORK_AREA`</li></ul> |
88-
| `removeUponCompletion` | Integer | If `1`, job will be removed once complete. |
82+
| Parameter | Type | Description |
83+
| ---------------------- | ------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------- |
84+
| `sequence` | [Sequence object](../sequence/sequence.md) | A sequence to render. |
85+
| `outputPath` | String | A path to an output file. |
86+
| `presetPath` | String | A path to a preset (.epr) file. |
87+
| `workArea` | Integer | Integer denoting work area to be used:<ul><li>`0` - `ENCODE_ENTIRE`</li><li>`1` - `ENCODE_IN_TO_OUT`</li><li>`2` - `ENCODE_WORK_AREA`</li></ul> |
88+
| `removeUponCompletion` | Integer | If `1`, job will be removed once complete. |
8989

9090
#### Returns
9191

@@ -121,7 +121,7 @@ Determines whether embedded XMP metadata, will be output.
121121

122122
#### Parameters
123123

124-
| Argument | Type | Description |
124+
| Parameter | Type | Description |
125125
| --------- | ------- | -------------------------------------------------- |
126126
| `enabled` | Integer | Pass `1` to enable sidecar output, `0` to disable. |
127127

@@ -146,7 +146,7 @@ Determines whether a sidecar file containing XMP metadata, will be output.
146146

147147
#### Parameters
148148

149-
| Argument | Type | Description |
149+
| Parameter | Type | Description |
150150
| --------- | ------- | -------------------------------------------------- |
151151
| `enabled` | Integer | Pass `1` to enable sidecar output, `0` to disable. |
152152

‎docs/general/marker.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -141,9 +141,9 @@ Gets the marker color index.
141141

142142
#### Parameters
143143

144-
| Argument | Type | Description |
145-
|------------|-----------|---------------------------------|
146-
| `index` | Integer | Index of the marker to be read. |
144+
| Parameter | Type | Description |
145+
| --------- | ------- | ------------------------------- |
146+
| `index` | Integer | Index of the marker to be read. |
147147

148148
#### Returns
149149

@@ -218,8 +218,8 @@ Sets the marker color by index. Color indices listed below.
218218

219219
#### Parameters
220220

221-
| Argument | Type | Description |
222-
|---------------|-----------|--------------------------------------------|
221+
| Parameter | Type | Description |
222+
| ------------- | ------- | ------------------------------------------ |
223223
| `colorIndex` | Integer | Index of the color to apply to the marker. |
224224
| `markerIndex` | Integer | Index of the marker to be set. |
225225

‎docs/general/production.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ Copies a project from some other location, into the Production directory.
6464

6565
#### Parameters
6666

67-
| Argument | Type | Description |
67+
| Parameter | Type | Description |
6868
| ----------------- | ------ | ------------------------------------- |
6969
| `srcProjectPath` | String | A path to the source project. |
7070
| `destProjectPath` | String | A destination path for added project. |
@@ -103,7 +103,7 @@ Returns the lock state of a single project within the Production.
103103

104104
#### Parameters
105105

106-
| Argument | Type | Description |
106+
| Parameter | Type | Description |
107107
| --------- | ------------------------------ | ----------- |
108108
| `project` | [Project object](./project.md) | The project |
109109

@@ -123,7 +123,7 @@ Moves the specified path ("bin") or .prproj into the Production's Trash folder.
123123

124124
#### Parameters
125125

126-
| Argument | Type | Description |
126+
| Parameter | Type | Description |
127127
| --------------------- | ------- | -------------------------------------------- |
128128
| `projectOrFolderPath` | String | A path to the source project. |
129129
| `suppressUI` | Boolean | Whether to suppress any resultant dialogues. |
@@ -145,7 +145,7 @@ Sets the lock state of the specified project within the Production.
145145

146146
#### Parameters
147147

148-
| Argument | Type | Description |
148+
| Parameter | Type | Description |
149149
| --------- | ---------------- | ---------------------------------------- |
150150
| `project` | `Project object` | The project |
151151
| `locked` | Boolean | `True` for locked, `false` for unlocked. |

0 commit comments

Comments
 (0)