Skip to content
Permalink
Browse files

docs(generic): fix option variable names

  • Loading branch information
malept committed Jan 3, 2017
1 parent 9c118a4 commit 0923ac1eb87621fab5e3ca2f759d4d6892178eeb
Showing with 8 additions and 8 deletions.
  1. +1 −1 src/api/import.js
  2. +1 −1 src/api/init.js
  3. +1 −1 src/api/install.js
  4. +1 −1 src/api/lint.js
  5. +1 −1 src/api/make.js
  6. +1 −1 src/api/package.js
  7. +1 −1 src/api/publish.js
  8. +1 −1 src/api/start.js
@@ -26,7 +26,7 @@ const d = debug('electron-forge:import');
* - Sets up `git` and the correct NPM dependencies
* - Adds a template forge config to `package.json`
*
* @param {ImportOptions} options - Options for the import method
* @param {ImportOptions} providedOptions - Options for the import method
* @return {Promise} Will resolve when the import process is complete
*/
export default async (providedOptions = {}) => {
@@ -22,7 +22,7 @@ const d = debug('electron-forge:init');
/**
* Initialize a new Electron Forge template project in the given directory.
*
* @param {InitOptions} options - Options for the init method
* @param {InitOptions} providedOptions - Options for the init method
* @return {Promise} Will resolve when the initialization process is complete
*/
export default async (providedOptions = {}) => {
@@ -32,7 +32,7 @@ const GITHUB_API = 'https://api.github.com';
/**
* Install an Electron application from GitHub. If you leave interactive as `false`, you MUST provide a `chooseAsset` function.
*
* @param {InstallOptions} options - Options for the install method
* @param {InstallOptions} providedOptions - Options for the install method
* @return {Promise} Will resolve when the install process is complete
*/
export default async (providedOptions = {}) => {
@@ -19,7 +19,7 @@ const d = debug('electron-forge:lint');
* The promise will be rejected with the stdout+stderr of the linting process if linting fails or
* will be resolved if it succeeds.
*
* @param {LintOptions} options - Options for the Lint method
* @param {LintOptions} providedOptions - Options for the Lint method
* @return {Promise<null, string>} Will resolve when the lint process is complete
*/
export default async (providedOptions = {}) => {
@@ -24,7 +24,7 @@ import packager from './package';
/**
* Make distributables for an Electron application.
*
* @param {MakeOptions} options - Options for the make method
* @param {MakeOptions} providedOptions - Options for the make method
* @return {Promise} Will resolve when the make process is complete
*/
export default async (providedOptions = {}) => {
@@ -24,7 +24,7 @@ import resolveDir from '../util/resolve-dir';
/**
* Package an Electron application into an platform dependent format.
*
* @param {PackageOptions} options - Options for the Package method
* @param {PackageOptions} providedOptions - Options for the Package method
* @return {Promise} Will resolve when the package process is complete
*/
export default async (providedOptions = {}) => {
@@ -21,7 +21,7 @@ import make from './make';
/**
* Publish an Electron application into the given target service.
*
* @param {PublishOptions} options - Options for the Publish method
* @param {PublishOptions} providedOptions - Options for the Publish method
* @return {Promise} Will resolve when the publish process is complete
*/
export default async (providedOptions = {}) => {
@@ -18,7 +18,7 @@ import resolveDir from '../util/resolve-dir';
/**
* Start an Electron application.
*
* @param {StartOptions} options - Options for the Publish method
* @param {StartOptions} providedOptions - Options for the Publish method
* @return {Promise} Will resolve when the application is launched
*/
export default async (providedOptions = {}) => {

0 comments on commit 0923ac1

Please sign in to comment.
You can’t perform that action at this time.