From b7326cc72bde485f85b5097ac88b5291fa19ab1e Mon Sep 17 00:00:00 2001 From: Stephen Cavaliere Date: Fri, 17 Mar 2017 15:49:35 -0400 Subject: [PATCH] docs(@angular/cli): fix a few documentation inconsistencies --- docs/documentation/_Sidebar.md | 2 +- docs/documentation/build.md | 2 -- docs/documentation/config.md | 2 +- docs/documentation/e2e.md | 2 +- docs/documentation/generate/component.md | 6 +++--- docs/documentation/generate/guard.md | 4 ++-- docs/documentation/generate/pipe.md | 2 +- docs/documentation/generate/service.md | 2 +- docs/documentation/lint.md | 1 - docs/documentation/new.md | 2 +- docs/documentation/serve.md | 2 +- docs/documentation/test.md | 2 +- docs/documentation/xi18n.md | 8 ++++---- packages/@angular/cli/blueprints/guard/index.ts | 2 +- packages/@angular/cli/blueprints/service/index.ts | 2 +- 15 files changed, 19 insertions(+), 22 deletions(-) diff --git a/docs/documentation/_Sidebar.md b/docs/documentation/_Sidebar.md index 4a898cad4845..0a2ada937078 100644 --- a/docs/documentation/_Sidebar.md +++ b/docs/documentation/_Sidebar.md @@ -1,3 +1,3 @@ * [Angular CLI](home) * [Generate](generate) -* [Stories](stories) \ No newline at end of file +* [Stories](stories) diff --git a/docs/documentation/build.md b/docs/documentation/build.md index 31f41dd2a9f0..2db86ba97353 100644 --- a/docs/documentation/build.md +++ b/docs/documentation/build.md @@ -75,8 +75,6 @@ or `ng serve --prod` will also make use of uglifying and tree-shaking functional `--dev` Build target and environment to development. -`--output-path` (`-op`) path where output will be placed - `--environment` (`-e`) Defines the build environment. `--extract-css` (`-ec`) Extract css from global styles onto css files instead of js ones. diff --git a/docs/documentation/config.md b/docs/documentation/config.md index ec7b6b3d3591..ed9a832f13f4 100644 --- a/docs/documentation/config.md +++ b/docs/documentation/config.md @@ -15,4 +15,4 @@ `ng set [key]=[value]` Set a value in the configuration. ## Options -`--global` Set the value in the global configuration rather than in your project's. \ No newline at end of file +`--global` Set the value in the global configuration rather than in your project's. diff --git a/docs/documentation/e2e.md b/docs/documentation/e2e.md index 58fefdbf0153..2ed23090000a 100644 --- a/docs/documentation/e2e.md +++ b/docs/documentation/e2e.md @@ -22,4 +22,4 @@ End-to-end tests are run via [Protractor](https://angular.github.io/protractor/) `--specs` Override specs in the protractor config. Can send in multiple specs by repeating flag (ng e2e --specs=spec1.ts --specs=spec2.ts). -`--webdriver-update` (`-wu`) (Default: true) Try to update webdriver. \ No newline at end of file +`--webdriver-update` (`-wu`) (Default: true) Try to update webdriver. diff --git a/docs/documentation/generate/component.md b/docs/documentation/generate/component.md index 5a53bcd0acef..8740279517e0 100644 --- a/docs/documentation/generate/component.md +++ b/docs/documentation/generate/component.md @@ -10,10 +10,10 @@ `--change-detection` (`-cd`) Specifies the change detection strategy. -`--flat` Flag to indicate if a dir is created. - `--export` Specifies if declaring module exports the component. +`--flat` Flag to indicate if a dir is created. + `--inline-style` (`-is`) Specifies if the style will be in the ts file. `--inline-template` (`-it`) Specifies if the template will be in the ts file. @@ -26,4 +26,4 @@ `--spec` Specifies if a spec file is generated. -`--view-encapsulation` (`-ve`) Specifies the view encapsulation strategy. \ No newline at end of file +`--view-encapsulation` (`-ve`) Specifies the view encapsulation strategy. diff --git a/docs/documentation/generate/guard.md b/docs/documentation/generate/guard.md index 3a78fbcb7ef1..77bdec601f6e 100644 --- a/docs/documentation/generate/guard.md +++ b/docs/documentation/generate/guard.md @@ -8,6 +8,6 @@ `--flat` Indicate if a dir is created. -`--module` (`-m`) Allows specification of the declaring module. +`--module` (`-m`) Specifies where the guard should be provided. -`--spec` Specifies if a spec file is generated. \ No newline at end of file +`--spec` Specifies if a spec file is generated. diff --git a/docs/documentation/generate/pipe.md b/docs/documentation/generate/pipe.md index 7446b069522e..e54bfae30309 100644 --- a/docs/documentation/generate/pipe.md +++ b/docs/documentation/generate/pipe.md @@ -16,4 +16,4 @@ `--skip-import` Allows for skipping the module import. -`--spec` Specifies if a spec file is generated. \ No newline at end of file +`--spec` Specifies if a spec file is generated. diff --git a/docs/documentation/generate/service.md b/docs/documentation/generate/service.md index 9d7d3a02af85..145e148d303d 100644 --- a/docs/documentation/generate/service.md +++ b/docs/documentation/generate/service.md @@ -10,6 +10,6 @@ `--flat` Flag to indicate if a dir is created. -`--module` (`-m`) Allows you to specify the module where the service should be provided +`--module` (`-m`) Specifies where the service should be provided. `--spec` Specifies if a spec file is generated. diff --git a/docs/documentation/lint.md b/docs/documentation/lint.md index 7d1cd8729f83..35ce3786f01c 100644 --- a/docs/documentation/lint.md +++ b/docs/documentation/lint.md @@ -6,7 +6,6 @@ `ng lint` will lint you app code using tslint. ## Options - `--fix` Fixes linting errors (may overwrite linted files). `--force` Succeeds even if there was linting errors. diff --git a/docs/documentation/new.md b/docs/documentation/new.md index 616908532988..4730880f6e41 100644 --- a/docs/documentation/new.md +++ b/docs/documentation/new.md @@ -36,4 +36,4 @@ Default applications are created in a directory of the same name, with an initia `--style` The style file default extension. -`--verbose` Adds more details to output logging. \ No newline at end of file +`--verbose` Adds more details to output logging. diff --git a/docs/documentation/serve.md b/docs/documentation/serve.md index 6d722294bdc7..16513e458d95 100644 --- a/docs/documentation/serve.md +++ b/docs/documentation/serve.md @@ -27,4 +27,4 @@ All the build Options are available in serve, below are the additional options. `--ssl-key` SSL key to use for serving HTTPS. ## Note -When running `ng serve`, the compiled output is served from memory, not from disk. This means that the application being served is not located on disk in the `dist` folder. \ No newline at end of file +When running `ng serve`, the compiled output is served from memory, not from disk. This means that the application being served is not located on disk in the `dist` folder. diff --git a/docs/documentation/test.md b/docs/documentation/test.md index 18c3c633b282..ad5bc59a6ed3 100644 --- a/docs/documentation/test.md +++ b/docs/documentation/test.md @@ -40,4 +40,4 @@ You can run tests with coverage via `--code-coverage`. The coverage report will `--sourcemap` Output sourcemaps. -`--watch` (`-w`) Run build when files change. \ No newline at end of file +`--watch` (`-w`) Run build when files change. diff --git a/docs/documentation/xi18n.md b/docs/documentation/xi18n.md index fa2285d7be78..1e3fe3fbb200 100644 --- a/docs/documentation/xi18n.md +++ b/docs/documentation/xi18n.md @@ -6,16 +6,16 @@ `ng xi18n` Extracts i18n messages from the templates. ## Options -`--i18n-format` (`-f`) Output format for the generated file: either `xmb` or `xlf`. +`--app` (`-a`) Specifies app name to use. -`--output-path` (`-op`) Path where output will be placed. +`--i18n-format` (`-f`) Output format for the generated file: either `xmb` or `xlf`. `--locale` (`-l`) Specifies the source language of the application. `--outfile` (`-of`) Name of the file to output. -`--verbose` Adds more details to output logging. +`--output-path` (`-op`) Path where output will be placed. `--progress` Log progress to the console while running. -`--app` (`-a`) Specifies app name to use. \ No newline at end of file +`--verbose` Adds more details to output logging. diff --git a/packages/@angular/cli/blueprints/guard/index.ts b/packages/@angular/cli/blueprints/guard/index.ts index 04ab6977b5d0..6e6877dcf4d8 100644 --- a/packages/@angular/cli/blueprints/guard/index.ts +++ b/packages/@angular/cli/blueprints/guard/index.ts @@ -31,7 +31,7 @@ export default Blueprint.extend({ name: 'module', type: String, aliases: ['m'], - description: 'Allows specification of the declaring module.' + description: 'Specifies where the guard should be provided.' } ], diff --git a/packages/@angular/cli/blueprints/service/index.ts b/packages/@angular/cli/blueprints/service/index.ts index 5443238603e1..cb239f0f6c0c 100644 --- a/packages/@angular/cli/blueprints/service/index.ts +++ b/packages/@angular/cli/blueprints/service/index.ts @@ -30,7 +30,7 @@ export default Blueprint.extend({ { name: 'module', type: String, aliases: ['m'], - description: 'Allows specification of the declaring module.' + description: 'Specifies where the service should be provided.' }, { name: 'app',