Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(@angular/cli): fix a few documentation inconsistencies #5488

Closed
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/documentation/_Sidebar.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
* [Angular CLI](home)
* [Generate](generate)
* [Stories](stories)
* [Stories](stories)
2 changes: 0 additions & 2 deletions docs/documentation/build.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion docs/documentation/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
`--global` Set the value in the global configuration rather than in your project's.
2 changes: 1 addition & 1 deletion docs/documentation/e2e.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
`--webdriver-update` (`-wu`) (Default: true) Try to update webdriver.
6 changes: 3 additions & 3 deletions docs/documentation/generate/component.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -26,4 +26,4 @@

`--spec` Specifies if a spec file is generated.

`--view-encapsulation` (`-ve`) Specifies the view encapsulation strategy.
`--view-encapsulation` (`-ve`) Specifies the view encapsulation strategy.
4 changes: 2 additions & 2 deletions docs/documentation/generate/guard.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
`--spec` Specifies if a spec file is generated.
2 changes: 1 addition & 1 deletion docs/documentation/generate/pipe.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,4 @@

`--skip-import` Allows for skipping the module import.

`--spec` Specifies if a spec file is generated.
`--spec` Specifies if a spec file is generated.
2 changes: 1 addition & 1 deletion docs/documentation/generate/service.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
1 change: 0 additions & 1 deletion docs/documentation/lint.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion docs/documentation/new.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
`--verbose` Adds more details to output logging.
2 changes: 1 addition & 1 deletion docs/documentation/serve.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
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.
2 changes: 1 addition & 1 deletion docs/documentation/test.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
`--watch` (`-w`) Run build when files change.
8 changes: 4 additions & 4 deletions docs/documentation/xi18n.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
`--verbose` Adds more details to output logging.
2 changes: 1 addition & 1 deletion packages/@angular/cli/blueprints/guard/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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.'
}
],

Expand Down
2 changes: 1 addition & 1 deletion packages/@angular/cli/blueprints/service/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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',
Expand Down