Skip to content

Commit 33ef0d2

Browse files
ckerrmaleptJohn Kleinschmidt
authored
docs: minor grammar & spelling fixes (electron#22851)
* docs: fix minor grammar error 'punctuations' * docs: fix minor grammar error pluralizing Chromium * docs: fix typo 'updateCurrentActiviy' * docs: use consistent spelling of 'behavior' * docs: use 'macOS' instead of 'Mac OS' or 'OS X'. * docs: use 'GTK' instead of 'GTK+' https://mail.gnome.org/archives/gtk-devel-list/2019-February/msg00000.html * docs: minor capitalization: use 'TCP' not 'tcp' * Update docs/development/build-instructions-linux.md Co-Authored-By: Mark Lee <malept@users.noreply.github.com> Co-authored-by: Mark Lee <malept@users.noreply.github.com> Co-authored-by: John Kleinschmidt <jkleinsc@github.com>
1 parent fea3366 commit 33ef0d2

File tree

32 files changed

+52
-52
lines changed

32 files changed

+52
-52
lines changed

docs/api/accelerator.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ The `Super` key is mapped to the `Windows` key on Windows and Linux and
5454
* `0` to `9`
5555
* `A` to `Z`
5656
* `F1` to `F24`
57-
* Punctuations like `~`, `!`, `@`, `#`, `$`, etc.
57+
* Punctuation like `~`, `!`, `@`, `#`, `$`, etc.
5858
* `Plus`
5959
* `Space`
6060
* `Tab`

docs/api/app.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ Returns:
7575
* `event` Event
7676

7777
Emitted when all windows have been closed and the application will quit.
78-
Calling `event.preventDefault()` will prevent the default behaviour, which is
78+
Calling `event.preventDefault()` will prevent the default behavior, which is
7979
terminating the application.
8080

8181
See the description of the `window-all-closed` event for the differences between
@@ -204,7 +204,7 @@ Returns:
204204
[`NSUserActivity.activityType`][activity-type].
205205
* `userInfo` unknown - Contains app-specific state stored by the activity.
206206

207-
Emitted when [Handoff][handoff] is about to be resumed on another device. If you need to update the state to be transferred, you should call `event.preventDefault()` immediately, construct a new `userInfo` dictionary and call `app.updateCurrentActiviy()` in a timely manner. Otherwise, the operation will fail and `continue-activity-error` will be called.
207+
Emitted when [Handoff][handoff] is about to be resumed on another device. If you need to update the state to be transferred, you should call `event.preventDefault()` immediately, construct a new `userInfo` dictionary and call `app.updateCurrentActivity()` in a timely manner. Otherwise, the operation will fail and `continue-activity-error` will be called.
208208

209209
### Event: 'new-window-for-tab' _macOS_
210210

@@ -1027,7 +1027,7 @@ This method can only be called before app is ready.
10271027

10281028
By default, Chromium disables 3D APIs (e.g. WebGL) until restart on a per
10291029
domain basis if the GPU processes crashes too frequently. This function
1030-
disables that behaviour.
1030+
disables that behavior.
10311031

10321032
This method can only be called before app is ready.
10331033

@@ -1196,7 +1196,7 @@ Show the app's about panel options. These options can be overridden with `app.se
11961196
* `website` String (optional) _Linux_ - The app's website.
11971197
* `iconPath` String (optional) _Linux_ _Windows_ - Path to the app's icon. On Linux, will be shown as 64x64 pixels while retaining aspect ratio.
11981198

1199-
Set the about panel options. This will override the values defined in the app's `.plist` file on MacOS. See the [Apple docs][about-panel-options] for more details. On Linux, values must be set in order to be shown; there are no defaults.
1199+
Set the about panel options. This will override the values defined in the app's `.plist` file on macOS. See the [Apple docs][about-panel-options] for more details. On Linux, values must be set in order to be shown; there are no defaults.
12001200

12011201
If you do not set `credits` but still wish to surface them in your app, AppKit will look for a file named "Credits.html", "Credits.rtf", and "Credits.rtfd", in that order, in the bundle returned by the NSBundle class method main. The first file found is used, and if none is found, the info area is left blank. See Apple [documentation](https://developer.apple.com/documentation/appkit/nsaboutpaneloptioncredits?language=objc) for more information.
12021202

docs/api/browser-window.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -207,7 +207,7 @@ It creates a new `BrowserWindow` with native properties as set by the `options`.
207207
* `opacity` Number (optional) - Set the initial opacity of the window, between 0.0 (fully
208208
transparent) and 1.0 (fully opaque). This is only implemented on Windows and macOS.
209209
* `darkTheme` Boolean (optional) - Forces using dark theme for the window, only works on
210-
some GTK+3 desktop environments. Default is [`nativeTheme.shouldUseDarkColors`](native-theme.md).
210+
some GTK desktop environments. Default is [`nativeTheme.shouldUseDarkColors`](native-theme.md).
211211
* `transparent` Boolean (optional) - Makes the window [transparent](frameless-window.md#transparent-window).
212212
Default is `false`. On Windows, does not work unless the window is frameless.
213213
* `type` String (optional) - The type of window, default is normal window. See more about
@@ -952,7 +952,7 @@ Returns `Boolean` - Whether the window is in fullscreen mode.
952952

953953
Enters or leaves simple fullscreen mode.
954954

955-
Simple fullscreen mode emulates the native fullscreen behavior found in versions of Mac OS X prior to Lion (10.7).
955+
Simple fullscreen mode emulates the native fullscreen behavior found in versions of macOS prior to Lion (10.7).
956956

957957
#### `win.isSimpleFullScreen()` _macOS_
958958

docs/api/command-line-switches.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -216,7 +216,7 @@ Aliased to `--debug-port=[host:]port`.
216216

217217
Activate inspector on `host:port`. Default is `127.0.0.1:9229`.
218218

219-
V8 inspector integration allows tools such as Chrome DevTools and IDEs to debug and profile Electron instances. The tools attach to Electron instances via a tcp port and communicate using the [Chrome DevTools Protocol](https://chromedevtools.github.io/devtools-protocol/).
219+
V8 inspector integration allows tools such as Chrome DevTools and IDEs to debug and profile Electron instances. The tools attach to Electron instances via a TCP port and communicate using the [Chrome DevTools Protocol](https://chromedevtools.github.io/devtools-protocol/).
220220

221221
See the [Debugging the Main Process][debugging-main-process] guide for more details.
222222

docs/api/frameless-window.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ win.show()
5252
Uses custom drawn close, and miniaturize buttons that display
5353
when hovering in the top left of the window. The fullscreen button
5454
is not available due to restrictions of frameless windows as they
55-
interface with Apple's MacOS window masks. These custom buttons prevent
55+
interface with Apple's macOS window masks. These custom buttons prevent
5656
issues with mouse events that occur with the standard window toolbar buttons.
5757
This option is only applicable for frameless windows.
5858

@@ -158,7 +158,7 @@ buttons in titlebar non-draggable.
158158

159159
## Text selection
160160

161-
In a frameless window the dragging behaviour may conflict with selecting text.
161+
In a frameless window the dragging behavior may conflict with selecting text.
162162
For example, when you drag the titlebar you may accidentally select the text on
163163
the titlebar. To prevent this, you need to disable text selection within a
164164
draggable area like this:

docs/api/menu-item.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,7 @@ When specifying a `role` on macOS, `label` and `accelerator` are the only
117117
options that will affect the menu item. All other options will be ignored.
118118
Lowercase `role`, e.g. `toggledevtools`, is still supported.
119119

120-
**Nota Bene:** The `enabled` and `visibility` properties are not available for top-level menu items in the tray on MacOS.
120+
**Nota Bene:** The `enabled` and `visibility` properties are not available for top-level menu items in the tray on macOS.
121121

122122
### Instance Properties
123123

docs/api/sandbox-option.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ app.whenReady().then(() => {
5151

5252
In the above code the [`BrowserWindow`](browser-window.md) that was created has Node.js disabled and can communicate
5353
only via IPC. The use of this option stops Electron from creating a Node.js runtime in the renderer. Also,
54-
within this new window `window.open` follows the native behaviour (by default Electron creates a [`BrowserWindow`](browser-window.md)
54+
within this new window `window.open` follows the native behavior (by default Electron creates a [`BrowserWindow`](browser-window.md)
5555
and returns a proxy to this via `window.open`).
5656

5757
[`app.enableSandbox`](app.md#appenablesandbox-experimental) can be used to force `sandbox: true` for all `BrowserWindow` instances.

docs/api/system-preferences.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -326,7 +326,7 @@ This API is only available on macOS 10.14 Mojave or newer.
326326
* `window-frame-text` - The text in the window's titlebar area.
327327

328328
Returns `String` - The system color setting in RGB hexadecimal form (`#ABCDEF`).
329-
See the [Windows docs][windows-colors] and the [MacOS docs][macos-colors] for more details.
329+
See the [Windows docs][windows-colors] and the [macOS docs][macos-colors] for more details.
330330

331331
The following colors are only available on macOS 10.14: `find-highlight`, `selected-content-background`, `separator`, `unemphasized-selected-content-background`, `unemphasized-selected-text-background`, and `unemphasized-selected-text`.
332332

docs/breaking-changes.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ This document uses the following convention to categorize breaking changes:
1717
### Removed: Browser Window Affinity
1818

1919
The `affinity` option when constructing a new `BrowserWindow` will be removed
20-
as part of our plan to more closely align with Chromiums process model for security,
20+
as part of our plan to more closely align with Chromium's process model for security,
2121
performance and maintainability.
2222

2323
For more detailed information see [#18397](https://github.com/electron/electron/issues/18397).

docs/development/build-instructions-linux.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ Follow the guidelines below for building Electron on Linux.
2525
Doing so permits installing Node on your own home directory as a standard user.
2626
Or try repositories such as [NodeSource](https://nodesource.com/blog/nodejs-v012-iojs-and-the-nodesource-linux-repositories).
2727
* [clang](https://clang.llvm.org/get_started.html) 3.4 or later.
28-
* Development headers of GTK+ and libnotify.
28+
* Development headers of GTK 3 and libnotify.
2929

3030
On Ubuntu, install the following libraries:
3131

docs/development/build-instructions-macos.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ $ pip install pyobjc
4242
If you're developing Electron and don't plan to redistribute your
4343
custom Electron build, you may skip this section.
4444

45-
Official Electron builds are built with [Xcode 9.4.1](http://adcdownload.apple.com/Developer_Tools/Xcode_9.4.1/Xcode_9.4.1.xip), and the MacOS 10.13 SDK. Building with a newer SDK works too, but the releases currently use the 10.13 SDK.
45+
Official Electron builds are built with [Xcode 9.4.1](http://adcdownload.apple.com/Developer_Tools/Xcode_9.4.1/Xcode_9.4.1.xip), and the macOS 10.13 SDK. Building with a newer SDK works too, but the releases currently use the 10.13 SDK.
4646

4747
## Building Electron
4848

docs/development/debugging-instructions-macos.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ you prefer a graphical interface.
2020
tail calls, and other compiler optimizations.
2121

2222
* **Xcode**: In addition to Xcode, also install the Xcode command line tools.
23-
They include LLDB, the default debugger in Xcode on Mac OS X. It supports
23+
They include LLDB, the default debugger in Xcode on macOS. It supports
2424
debugging C, Objective-C and C++ on the desktop and iOS devices and simulator.
2525

2626
* **.lldbinit**: Create or edit `~/.lldbinit` to allow Chromium code to be properly source-mapped.

docs/development/pull-requests.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ $ git fetch upstream
3535

3636
Build steps and dependencies differ slightly depending on your operating system.
3737
See these detailed guides on building Electron locally:
38-
* [Building on MacOS](https://electronjs.org/docs/development/build-instructions-macos)
38+
* [Building on macOS](https://electronjs.org/docs/development/build-instructions-macos)
3939
* [Building on Linux](https://electronjs.org/docs/development/build-instructions-linux)
4040
* [Building on Windows](https://electronjs.org/docs/development/build-instructions-windows)
4141

docs/fiddles/menus/customize-menus/main.js

+2-2
Original file line numberDiff line numberDiff line change
@@ -324,7 +324,7 @@ app.whenReady().then(() => {
324324

325325
// Quit when all windows are closed.
326326
app.on('window-all-closed', function () {
327-
// On OS X it is common for applications and their menu bar
327+
// On macOS it is common for applications and their menu bar
328328
// to stay active until the user quits explicitly with Cmd + Q
329329
const reopenMenuItem = findReopenMenuItem()
330330
if (reopenMenuItem) reopenMenuItem.enabled = true
@@ -335,7 +335,7 @@ app.on('window-all-closed', function () {
335335
})
336336

337337
app.on('activate', function () {
338-
// On OS X it's common to re-create a window in the app when the
338+
// On macOS it is common to re-create a window in the app when the
339339
// dock icon is clicked and there are no other windows open.
340340
if (mainWindow === null) {
341341
createWindow()

docs/fiddles/menus/shortcuts/main.js

+2-2
Original file line numberDiff line numberDiff line change
@@ -46,15 +46,15 @@ app.whenReady().then(createWindow)
4646

4747
// Quit when all windows are closed.
4848
app.on('window-all-closed', function () {
49-
// On OS X it is common for applications and their menu bar
49+
// On macOS it is common for applications and their menu bar
5050
// to stay active until the user quits explicitly with Cmd + Q
5151
if (process.platform !== 'darwin') {
5252
app.quit()
5353
}
5454
})
5555

5656
app.on('activate', function () {
57-
// On OS X it's common to re-create a window in the app when the
57+
// On macOS it is common to re-create a window in the app when the
5858
// dock icon is clicked and there are no other windows open.
5959
if (mainWindow === null) {
6060
createWindow()

docs/fiddles/native-ui/dialogs/error-dialog/main.js

+2-2
Original file line numberDiff line numberDiff line change
@@ -37,15 +37,15 @@ app.whenReady().then(createWindow)
3737

3838
// Quit when all windows are closed.
3939
app.on('window-all-closed', function () {
40-
// On OS X it is common for applications and their menu bar
40+
// On macOS it is common for applications and their menu bar
4141
// to stay active until the user quits explicitly with Cmd + Q
4242
if (process.platform !== 'darwin') {
4343
app.quit()
4444
}
4545
})
4646

4747
app.on('activate', function () {
48-
// On OS X it's common to re-create a window in the app when the
48+
// On macOS it is common to re-create a window in the app when the
4949
// dock icon is clicked and there are no other windows open.
5050
if (mainWindow === null) {
5151
createWindow()

docs/fiddles/native-ui/dialogs/information-dialog/main.js

+2-2
Original file line numberDiff line numberDiff line change
@@ -37,15 +37,15 @@ app.whenReady().then(createWindow)
3737

3838
// Quit when all windows are closed.
3939
app.on('window-all-closed', function () {
40-
// On OS X it is common for applications and their menu bar
40+
// On macOS it is common for applications and their menu bar
4141
// to stay active until the user quits explicitly with Cmd + Q
4242
if (process.platform !== 'darwin') {
4343
app.quit()
4444
}
4545
})
4646

4747
app.on('activate', function () {
48-
// On OS X it's common to re-create a window in the app when the
48+
// On macOS it is common to re-create a window in the app when the
4949
// dock icon is clicked and there are no other windows open.
5050
if (mainWindow === null) {
5151
createWindow()

docs/fiddles/native-ui/dialogs/open-file-or-directory/main.js

+2-2
Original file line numberDiff line numberDiff line change
@@ -37,15 +37,15 @@ app.whenReady().then(createWindow)
3737

3838
// Quit when all windows are closed.
3939
app.on('window-all-closed', function () {
40-
// On OS X it is common for applications and their menu bar
40+
// On macOS it is common for applications and their menu bar
4141
// to stay active until the user quits explicitly with Cmd + Q
4242
if (process.platform !== 'darwin') {
4343
app.quit()
4444
}
4545
})
4646

4747
app.on('activate', function () {
48-
// On OS X it's common to re-create a window in the app when the
48+
// On macOS it is common to re-create a window in the app when the
4949
// dock icon is clicked and there are no other windows open.
5050
if (mainWindow === null) {
5151
createWindow()

docs/fiddles/native-ui/dialogs/save-dialog/main.js

+2-2
Original file line numberDiff line numberDiff line change
@@ -37,15 +37,15 @@ app.whenReady().then(createWindow)
3737

3838
// Quit when all windows are closed.
3939
app.on('window-all-closed', function () {
40-
// On OS X it is common for applications and their menu bar
40+
// On macOS it is common for applications and their menu bar
4141
// to stay active until the user quits explicitly with Cmd + Q
4242
if (process.platform !== 'darwin') {
4343
app.quit()
4444
}
4545
})
4646

4747
app.on('activate', function () {
48-
// On OS X it's common to re-create a window in the app when the
48+
// On macOS it is common to re-create a window in the app when the
4949
// dock icon is clicked and there are no other windows open.
5050
if (mainWindow === null) {
5151
createWindow()

docs/fiddles/native-ui/drag-and-drop/main.js

+2-2
Original file line numberDiff line numberDiff line change
@@ -36,15 +36,15 @@ app.whenReady().then(createWindow)
3636

3737
// Quit when all windows are closed.
3838
app.on('window-all-closed', function () {
39-
// On OS X it is common for applications and their menu bar
39+
// On macOS it is common for applications and their menu bar
4040
// to stay active until the user quits explicitly with Cmd + Q
4141
if (process.platform !== 'darwin') {
4242
app.quit()
4343
}
4444
})
4545

4646
app.on('activate', function () {
47-
// On OS X it's common to re-create a window in the app when the
47+
// On macOS it is common to re-create a window in the app when the
4848
// dock icon is clicked and there are no other windows open.
4949
if (mainWindow === null) {
5050
createWindow()

docs/fiddles/native-ui/external-links-file-manager/main.js

+2-2
Original file line numberDiff line numberDiff line change
@@ -37,15 +37,15 @@ app.whenReady().then(createWindow)
3737

3838
// Quit when all windows are closed.
3939
app.on('window-all-closed', function () {
40-
// On OS X it is common for applications and their menu bar
40+
// On macOS it is common for applications and their menu bar
4141
// to stay active until the user quits explicitly with Cmd + Q
4242
if (process.platform !== 'darwin') {
4343
app.quit()
4444
}
4545
})
4646

4747
app.on('activate', function () {
48-
// On OS X it's common to re-create a window in the app when the
48+
// On macOS it is common to re-create a window in the app when the
4949
// dock icon is clicked and there are no other windows open.
5050
if (mainWindow === null) {
5151
createWindow()

docs/fiddles/native-ui/notifications/main.js

+2-2
Original file line numberDiff line numberDiff line change
@@ -37,15 +37,15 @@ app.whenReady().then(createWindow)
3737

3838
// Quit when all windows are closed.
3939
app.on('window-all-closed', function () {
40-
// On OS X it is common for applications and their menu bar
40+
// On macOS it is common for applications and their menu bar
4141
// to stay active until the user quits explicitly with Cmd + Q
4242
if (process.platform !== 'darwin') {
4343
app.quit()
4444
}
4545
})
4646

4747
app.on('activate', function () {
48-
// On OS X it's common to re-create a window in the app when the
48+
// On macOS it is common to re-create a window in the app when the
4949
// dock icon is clicked and there are no other windows open.
5050
if (mainWindow === null) {
5151
createWindow()

docs/fiddles/native-ui/tray/main.js

+2-2
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/fiddles/system/protocol-handler/launch-app-from-URL-in-another-app/main.js

+2-2
Original file line numberDiff line numberDiff line change
@@ -38,15 +38,15 @@ app.whenReady().then(createWindow)
3838

3939
// Quit when all windows are closed.
4040
app.on('window-all-closed', function () {
41-
// On OS X it is common for applications and their menu bar
41+
// On macOS it is common for applications and their menu bar
4242
// to stay active until the user quits explicitly with Cmd + Q
4343
if (process.platform !== 'darwin') {
4444
app.quit()
4545
}
4646
})
4747

4848
app.on('activate', function () {
49-
// On OS X it's common to re-create a window in the app when the
49+
// On macOS it is common to re-create a window in the app when the
5050
// dock icon is clicked and there are no other windows open.
5151
if (mainWindow === null) {
5252
createWindow()

docs/fiddles/windows/manage-windows/frameless-window/main.js

+2-2
Original file line numberDiff line numberDiff line change
@@ -37,15 +37,15 @@ app.whenReady().then(createWindow)
3737

3838
// Quit when all windows are closed.
3939
app.on('window-all-closed', function () {
40-
// On OS X it is common for applications and their menu bar
40+
// On macOS it is common for applications and their menu bar
4141
// to stay active until the user quits explicitly with Cmd + Q
4242
if (process.platform !== 'darwin') {
4343
app.quit()
4444
}
4545
})
4646

4747
app.on('activate', function () {
48-
// On OS X it's common to re-create a window in the app when the
48+
// On macOS it is common to re-create a window in the app when the
4949
// dock icon is clicked and there are no other windows open.
5050
if (mainWindow === null) {
5151
createWindow()

docs/fiddles/windows/manage-windows/manage-window-state/main.js

+2-2
Original file line numberDiff line numberDiff line change
@@ -37,15 +37,15 @@ app.whenReady().then(createWindow)
3737

3838
// Quit when all windows are closed.
3939
app.on('window-all-closed', function () {
40-
// On OS X it is common for applications and their menu bar
40+
// On macOS it is common for applications and their menu bar
4141
// to stay active until the user quits explicitly with Cmd + Q
4242
if (process.platform !== 'darwin') {
4343
app.quit()
4444
}
4545
})
4646

4747
app.on('activate', function () {
48-
// On OS X it's common to re-create a window in the app when the
48+
// On macOS it is common to re-create a window in the app when the
4949
// dock icon is clicked and there are no other windows open.
5050
if (mainWindow === null) {
5151
createWindow()

0 commit comments

Comments
 (0)