From 799fd13c503c52deb095dfd234c88825a5ecab55 Mon Sep 17 00:00:00 2001 From: Zeke Sikelianos Date: Fri, 22 Apr 2016 11:42:54 -0700 Subject: [PATCH] more updates to api summaries based on feedback --- docs/api/auto-updater.md | 4 ++-- docs/api/chrome-command-line-switches.md | 4 ++-- docs/api/content-tracing.md | 6 +++--- docs/api/menu-item.md | 2 +- docs/api/protocol.md | 2 +- docs/api/window-open.md | 2 +- 6 files changed, 10 insertions(+), 10 deletions(-) diff --git a/docs/api/auto-updater.md b/docs/api/auto-updater.md index 8ad3f8f16e..211d0c69a5 100644 --- a/docs/api/auto-updater.md +++ b/docs/api/auto-updater.md @@ -1,8 +1,8 @@ # autoUpdater -> Enable apps to update themselves automatically. +> Enable apps to automatically update themselves. -The `autoUpdater` module provides and interface for the [Squirrel](https://github.com/Squirrel) framework. +The `autoUpdater` module provides an interface for the [Squirrel](https://github.com/Squirrel) framework. You can quickly launch a multi-platform release server for distributing your application by using one of these projects: diff --git a/docs/api/chrome-command-line-switches.md b/docs/api/chrome-command-line-switches.md index 71a5ce6a40..17059435ea 100644 --- a/docs/api/chrome-command-line-switches.md +++ b/docs/api/chrome-command-line-switches.md @@ -3,8 +3,8 @@ > Command line switches supported by Electron. You can use [app.commandLine.appendSwitch][append-switch] to append them in -your app's main script before the [ready][ready] event of [app][app] module is -emitted: +your app's main script before the [ready][ready] event of the [app][app] module +is emitted: ```javascript const app = require('electron').app; diff --git a/docs/api/content-tracing.md b/docs/api/content-tracing.md index 85036c0d70..a9414d3487 100644 --- a/docs/api/content-tracing.md +++ b/docs/api/content-tracing.md @@ -3,9 +3,9 @@ > Collect tracing data from Chromium's content module for finding performance bottlenecks and slow operations. -This module does not include a web interface -so you need to open `chrome://tracing/` in a Chrome browser and load the -generated file to view the result. +This module does not include a web interface so you need to open +`chrome://tracing/` in a Chrome browser and load the generated file to view the +result. ```javascript const contentTracing = require('electron').contentTracing; diff --git a/docs/api/menu-item.md b/docs/api/menu-item.md index 0b5db94311..b67032271e 100644 --- a/docs/api/menu-item.md +++ b/docs/api/menu-item.md @@ -1,6 +1,6 @@ # MenuItem -> Add items to application and context menus. +> Add items to native application menus and context menus. See [`menu`](menu.md) for examples. diff --git a/docs/api/protocol.md b/docs/api/protocol.md index fe7dfabc64..aa9b43486d 100644 --- a/docs/api/protocol.md +++ b/docs/api/protocol.md @@ -1,6 +1,6 @@ # protocol -> Register a custom protocol and intercept existing protocols. +> Register a custom protocol and intercept existing protocol requests. An example of implementing a protocol that has the same effect as the `file://` protocol: diff --git a/docs/api/window-open.md b/docs/api/window-open.md index b4f5057dae..abb0760f12 100644 --- a/docs/api/window-open.md +++ b/docs/api/window-open.md @@ -1,6 +1,6 @@ # The `window.open` function -> Create a new window in a web page. +> Open a new window and load a URL. When `window.open` is called to create a new window in a web page, a new instance of `BrowserWindow` will be created for the `url` and a proxy will be returned