From 2c8261b4292413b926f2d31da6cad39c4baf486d Mon Sep 17 00:00:00 2001 From: Zeke Sikelianos Date: Fri, 22 Apr 2016 10:30:49 -0700 Subject: [PATCH] update excerpts based on feedback --- docs/api/content-tracing.md | 3 ++- docs/api/desktop-capturer.md | 4 ++-- docs/api/download-item.md | 6 +++--- docs/api/protocol.md | 3 +-- docs/api/remote.md | 2 +- docs/api/session.md | 2 +- docs/api/synopsis.md | 2 +- docs/api/web-contents.md | 2 +- 8 files changed, 12 insertions(+), 12 deletions(-) diff --git a/docs/api/content-tracing.md b/docs/api/content-tracing.md index c69031850a..85036c0d70 100644 --- a/docs/api/content-tracing.md +++ b/docs/api/content-tracing.md @@ -1,6 +1,7 @@ # contentTracing -> Debug your application using Chromium's content module. +> 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 diff --git a/docs/api/desktop-capturer.md b/docs/api/desktop-capturer.md index 505dd9596a..dc523c3a42 100644 --- a/docs/api/desktop-capturer.md +++ b/docs/api/desktop-capturer.md @@ -1,7 +1,7 @@ # desktopCapturer -> Capture audio, video, and images from a microphone, camera, or -screen using the `getUserMedia` API. +> List `getUserMedia` sources for capturing audio, video, and images from a +microphone, camera, or screen. ```javascript // In the renderer process. diff --git a/docs/api/download-item.md b/docs/api/download-item.md index 0f38ceedac..4418f61c19 100644 --- a/docs/api/download-item.md +++ b/docs/api/download-item.md @@ -1,9 +1,9 @@ # DownloadItem -> Trigger file downloads from remote sources. +> Control file downloads from remote sources. -`DownloadItem` is an EventEmitter represents a download item in Electron. It -is used in `will-download` event of `Session` module, and allows users to +`DownloadItem` is an EventEmitter that represents a download item in Electron. +It is used in `will-download` event of `Session` module, and allows users to control the download item. ```javascript diff --git a/docs/api/protocol.md b/docs/api/protocol.md index b3062bb632..fe7dfabc64 100644 --- a/docs/api/protocol.md +++ b/docs/api/protocol.md @@ -1,7 +1,6 @@ # protocol -> Register a custom protocol to intercept click events from other running -applications. +> Register a custom protocol and intercept existing protocols. An example of implementing a protocol that has the same effect as the `file://` protocol: diff --git a/docs/api/remote.md b/docs/api/remote.md index 65f58f01b0..454758c913 100644 --- a/docs/api/remote.md +++ b/docs/api/remote.md @@ -1,6 +1,6 @@ # remote -> Communicate between the renderer process and the main process. +> Use main process modules from the renderer process. The `remote` module provides a simple way to do inter-process communication (IPC) between the renderer process (web page) and the main process. diff --git a/docs/api/session.md b/docs/api/session.md index 390a9a5e4d..5bc819fb2b 100644 --- a/docs/api/session.md +++ b/docs/api/session.md @@ -1,6 +1,6 @@ # session -> Manage browser cookies, cache, and other session data. +> Manage browser sessions, cookies, cache, proxy settings, etc. The `session` module can be used to create new `Session` objects. diff --git a/docs/api/synopsis.md b/docs/api/synopsis.md index 641df7e260..a2aa58f57f 100644 --- a/docs/api/synopsis.md +++ b/docs/api/synopsis.md @@ -1,6 +1,6 @@ # Synopsis -> Info about Node.js and the main and renderer processes. +> How to use Node.js and Electron APIs. All of [Node.js's built-in modules](http://nodejs.org/api/) are available in Electron and third-party node modules also fully supported as well (including diff --git a/docs/api/web-contents.md b/docs/api/web-contents.md index 5c0f457538..64e7cea60e 100644 --- a/docs/api/web-contents.md +++ b/docs/api/web-contents.md @@ -1,6 +1,6 @@ # webContents -> Render and control web pages using lifecycle events. +> Render and control web pages. `webContents` is an [EventEmitter](http://nodejs.org/api/events.html#events_class_events_eventemitter).