From aac31159b8e88784f87f10b6c5fea3adc7f51134 Mon Sep 17 00:00:00 2001 From: George Hafiz Date: Fri, 18 Nov 2016 00:34:48 +0000 Subject: [PATCH] Update formatting to prevent '[] ()' sequences (e.g. String[] (optional)), which breaks MD rendering on GitHub and hides the array indication --- docs/api/app.md | 8 ++++---- docs/api/browser-window.md | 4 ++-- docs/api/dialog.md | 4 ++-- docs/api/structures/thumbar-button.md | 2 +- docs/api/web-contents.md | 2 +- docs/api/web-view-tag.md | 2 +- 6 files changed, 11 insertions(+), 11 deletions(-) diff --git a/docs/api/app.md b/docs/api/app.md index 52c3738fb8ec..ae4685a5a398 100644 --- a/docs/api/app.md +++ b/docs/api/app.md @@ -321,7 +321,7 @@ and `will-quit` events will not be emitted. ### `app.relaunch([options])` * `options` Object (optional) - * `args` String[] (optional) + * `args` String[] - (optional) * `execPath` String (optional) Relaunches the app when current instance exits. @@ -462,7 +462,7 @@ Clears the recent documents list. app to handle `electron://` links, call this method with `electron` as the parameter. * `path` String (optional) _Windows_ - Defaults to `process.execPath` -* `args` String[] (optional) _Windows_ - Defaults to an empty array +* `args` String[] - (optional) _Windows_ - Defaults to an empty array Returns `Boolean` - Whether the call succeeded. @@ -486,7 +486,7 @@ The API uses the Windows Registry and LSSetDefaultHandlerForURLScheme internally * `protocol` String - The name of your protocol, without `://`. * `path` String (optional) _Windows_ - Defaults to `process.execPath` -* `args` String[] (optional) _Windows_ - Defaults to an empty array +* `args` String[] - (optional) _Windows_ - Defaults to an empty array Returns `Boolean` - Whether the call succeeded. @@ -498,7 +498,7 @@ protocol (aka URI scheme). If so, it will remove the app as the default handler. * `protocol` String - The name of your protocol, without `://`. * `path` String (optional) _Windows_ - Defaults to `process.execPath` -* `args` String[] (optional) _Windows_ - Defaults to an empty array +* `args` String[] - (optional) _Windows_ - Defaults to an empty array Returns `Boolean` diff --git a/docs/api/browser-window.md b/docs/api/browser-window.md index 95d3e826683c..5ff2380a5813 100644 --- a/docs/api/browser-window.md +++ b/docs/api/browser-window.md @@ -973,7 +973,7 @@ Same as `webContents.capturePage([rect, ]callback)`. * `httpReferrer` String (optional) - A HTTP Referrer url. * `userAgent` String (optional) - A user agent originating the request. * `extraHeaders` String (optional) - Extra headers separated by "\n" - * `postData` ([UploadRawData](structures/upload-raw-data.md) | [UploadFile](structures/upload-file.md) | [UploadFileSystem](structures/upload-file-system.md) | [UploadBlob](structures/upload-blob.md))[] (optional) + * `postData` ([UploadRawData](structures/upload-raw-data.md) | [UploadFile](structures/upload-file.md) | [UploadFileSystem](structures/upload-file-system.md) | [UploadBlob](structures/upload-blob.md))[] - (optional) Same as `webContents.loadURL(url[, options])`. @@ -1071,7 +1071,7 @@ The `buttons` is an array of `Button` objects: toolbar. * `click` Function * `tooltip` String (optional) - The text of the button's tooltip. - * `flags` String[] (optional) - Control specific states and behaviors of the + * `flags` String[] - (optional) - Control specific states and behaviors of the button. By default, it is `['enabled']`. The `flags` is an array that can include following `String`s: diff --git a/docs/api/dialog.md b/docs/api/dialog.md index bfe838082627..8fcba99d2f15 100644 --- a/docs/api/dialog.md +++ b/docs/api/dialog.md @@ -32,7 +32,7 @@ The `dialog` module has the following methods: * `buttonLabel` String (optional) - Custom label for the confirmation button, when left empty the default label will be used. * `filters` [FileFilter[]](structrs/file-filter.md) (optional) - * `properties` String[] (optional) - Contains which features the dialog should use, can + * `properties` String[] - (optional) - Contains which features the dialog should use, can contain `openFile`, `openDirectory`, `multiSelections`, `createDirectory` and `showHiddenFiles`. * `callback` Function (optional) @@ -95,7 +95,7 @@ will be passed via `callback(filename)` * `type` String (optional) - Can be `"none"`, `"info"`, `"error"`, `"question"` or `"warning"`. On Windows, "question" displays the same icon as "info", unless you set an icon using the "icon" option. - * `buttons` String[] (optional) - Array of texts for buttons. On Windows, an empty array + * `buttons` String[] - (optional) - Array of texts for buttons. On Windows, an empty array will result in one button labeled "OK". * `defaultId` Integer (optional) - Index of the button in the buttons array which will be selected by default when the message box opens. diff --git a/docs/api/structures/thumbar-button.md b/docs/api/structures/thumbar-button.md index 259195852a4f..fc97fb113278 100644 --- a/docs/api/structures/thumbar-button.md +++ b/docs/api/structures/thumbar-button.md @@ -4,7 +4,7 @@ toolbar. * `click` Function * `tooltip` String (optional) - The text of the button's tooltip. -* `flags` String[] (optional) - Control specific states and behaviors of the +* `flags` String[] - (optional) - Control specific states and behaviors of the button. By default, it is `['enabled']`. The `flags` is an array that can include following `String`s: diff --git a/docs/api/web-contents.md b/docs/api/web-contents.md index 4174c1a9ad20..eed5468510c0 100644 --- a/docs/api/web-contents.md +++ b/docs/api/web-contents.md @@ -490,7 +490,7 @@ win.loadURL('http://github.com') * `httpReferrer` String (optional) - A HTTP Referrer url. * `userAgent` String (optional) - A user agent originating the request. * `extraHeaders` String (optional) - Extra headers separated by "\n" - * `postData` ([UploadRawData](structures/upload-raw-data.md) | [UploadFile](structures/upload-file.md) | [UploadFileSystem](structures/upload-file-system.md) | [UploadBlob](structures/upload-blob.md))[] (optional) + * `postData` ([UploadRawData](structures/upload-raw-data.md) | [UploadFile](structures/upload-file.md) | [UploadFileSystem](structures/upload-file-system.md) | [UploadBlob](structures/upload-blob.md))[] - (optional) Loads the `url` in the window. The `url` must contain the protocol prefix, e.g. the `http://` or `file://`. If the load should bypass http cache then diff --git a/docs/api/web-view-tag.md b/docs/api/web-view-tag.md index ec3adbeee63e..3516953fa7a3 100644 --- a/docs/api/web-view-tag.md +++ b/docs/api/web-view-tag.md @@ -303,7 +303,7 @@ webview.addEventListener('dom-ready', () => { * `httpReferrer` String (optional) - A HTTP Referrer url. * `userAgent` String (optional) - A user agent originating the request. * `extraHeaders` String (optional) - Extra headers separated by "\n" - * `postData` ([UploadRawData](structures/upload-raw-data.md) | [UploadFile](structures/upload-file.md) | [UploadFileSystem](structures/upload-file-system.md) | [UploadBlob](structures/upload-blob.md))[] (optional) + * `postData` ([UploadRawData](structures/upload-raw-data.md) | [UploadFile](structures/upload-file.md) | [UploadFileSystem](structures/upload-file-system.md) | [UploadBlob](structures/upload-blob.md))[] - (optional) Loads the `url` in the webview, the `url` must contain the protocol prefix, e.g. the `http://` or `file://`.