Skip to content

Commit

Permalink
docs(misc): clean up api docs
Browse files Browse the repository at this point in the history
  • Loading branch information
vsavkin committed Dec 2, 2020
1 parent baa8c23 commit 93ebc83
Show file tree
Hide file tree
Showing 101 changed files with 118 additions and 118 deletions.
2 changes: 1 addition & 1 deletion docs/angular/api-angular/generators/move.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,4 +62,4 @@ Default: `true`

Type: `boolean`

Should the schematic update the import path to reflect the new location?
Should the generator update the import path to reflect the new location?
2 changes: 1 addition & 1 deletion docs/angular/api-angular/generators/stories.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ nx g stories ... --dry-run

Type: `boolean`

Automatically generate \*.spec.ts files in the cypress e2e app generated by the cypress-configure schematic
Automatically generate \*.spec.ts files in the cypress e2e app generated by the cypress-configure generator

### name

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,13 +28,13 @@ nx g storybook-configuration ... --dry-run

Type: `boolean`

Run the cypress-configure schematic
Run the cypress-configure generator

### generateCypressSpecs

Type: `boolean`

Automatically generate \*.spec.ts files in the cypress e2e app generated by the cypress-configure schematic
Automatically generate \*.spec.ts files in the cypress e2e app generated by the cypress-configure generator

### generateStories

Expand Down
2 changes: 1 addition & 1 deletion docs/angular/api-nest/generators/class.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ Flag to indicate if a directory is created.

Type: `string`

The name of generated schematic
The name of generated generator

### project

Expand Down
2 changes: 1 addition & 1 deletion docs/angular/api-nest/generators/controller.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ Flag to indicate if a directory is created.

Type: `string`

The name of generated schematic
The name of generated generator

### project

Expand Down
2 changes: 1 addition & 1 deletion docs/angular/api-nest/generators/decorator.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ Flag to indicate if a directory is created.

Type: `string`

The name of generated schematic
The name of generated generator

### project

Expand Down
2 changes: 1 addition & 1 deletion docs/angular/api-nest/generators/filter.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ Flag to indicate if a directory is created.

Type: `string`

The name of generated schematic
The name of generated generator

### project

Expand Down
2 changes: 1 addition & 1 deletion docs/angular/api-nest/generators/gateway.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ Flag to indicate if a directory is created.

Type: `string`

The name of generated schematic
The name of generated generator

### project

Expand Down
2 changes: 1 addition & 1 deletion docs/angular/api-nest/generators/guard.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ Flag to indicate if a directory is created.

Type: `string`

The name of generated schematic
The name of generated generator

### project

Expand Down
2 changes: 1 addition & 1 deletion docs/angular/api-nest/generators/interceptor.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ Flag to indicate if a directory is created.

Type: `string`

The name of generated schematic
The name of generated generator

### project

Expand Down
2 changes: 1 addition & 1 deletion docs/angular/api-nest/generators/interface.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ Flag to indicate if a directory is created.

Type: `string`

The name of generated schematic
The name of generated generator

### project

Expand Down
2 changes: 1 addition & 1 deletion docs/angular/api-nest/generators/middleware.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ Flag to indicate if a directory is created.

Type: `string`

The name of generated schematic
The name of generated generator

### project

Expand Down
2 changes: 1 addition & 1 deletion docs/angular/api-nest/generators/module.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ Flag to indicate if a directory is created.

Type: `string`

The name of generated schematic
The name of generated generator

### project

Expand Down
2 changes: 1 addition & 1 deletion docs/angular/api-nest/generators/pipe.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ Flag to indicate if a directory is created.

Type: `string`

The name of generated schematic
The name of generated generator

### project

Expand Down
2 changes: 1 addition & 1 deletion docs/angular/api-nest/generators/provider.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ Flag to indicate if a directory is created.

Type: `string`

The name of generated schematic
The name of generated generator

### project

Expand Down
2 changes: 1 addition & 1 deletion docs/angular/api-nest/generators/resolver.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ Flag to indicate if a directory is created.

Type: `string`

The name of generated schematic
The name of generated generator

### project

Expand Down
2 changes: 1 addition & 1 deletion docs/angular/api-nest/generators/service.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ Flag to indicate if a directory is created.

Type: `string`

The name of generated schematic
The name of generated generator

### project

Expand Down
2 changes: 1 addition & 1 deletion docs/angular/api-next/generators/application.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ Default: `false`

Type: `boolean`

Skip updating workspace.json with default schematic options based on values provided to this app (e.g. babel, style)
Skip updating workspace.json with default options based on values provided to this app (e.g. babel, style)

### style

Expand Down
4 changes: 2 additions & 2 deletions docs/angular/api-nx-plugin/generators/generator.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,13 +38,13 @@ Alias(es): d

Type: `string`

Schematic description
Generator description

### name

Type: `string`

Schematic name
Generator name

### project

Expand Down
2 changes: 1 addition & 1 deletion docs/angular/api-react/generators/application.md
Original file line number Diff line number Diff line change
Expand Up @@ -140,7 +140,7 @@ Default: `false`

Type: `boolean`

Skip updating workspace.json with default schematic options based on values provided to this app (e.g. babel, style).
Skip updating workspace.json with default options based on values provided to this app (e.g. babel, style).

### style

Expand Down
2 changes: 1 addition & 1 deletion docs/angular/api-react/generators/stories.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ nx g stories ... --dry-run

Type: `boolean`

Automatically generate \*.spec.ts files in the cypress e2e app generated by the cypress-configure schematic.
Automatically generate \*.spec.ts files in the cypress e2e app generated by the cypress-configure generator.

### js

Expand Down
4 changes: 2 additions & 2 deletions docs/angular/api-react/generators/storybook-configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,13 +28,13 @@ nx g storybook-configuration ... --dry-run

Type: `boolean`

Run the cypress-configure schematic.
Run the cypress-configure generator.

### generateCypressSpecs

Type: `boolean`

Automatically generate \*.spec.ts files in the cypress e2e app generated by the cypress-configure schematic
Automatically generate \*.spec.ts files in the cypress e2e app generated by the cypress-configure generator

### generateStories

Expand Down
2 changes: 1 addition & 1 deletion docs/angular/api-storybook/generators/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ nx g configuration ... --dry-run

Type: `boolean`

Run the cypress-configure schematic
Run the cypress-configure generator

### js

Expand Down
2 changes: 1 addition & 1 deletion docs/angular/api-workspace/generators/move.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,4 +62,4 @@ Default: `true`

Type: `boolean`

Should the schematic update the import path to reflect the new location?
Should the generator update the import path to reflect the new location?
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ nx g workspace-generator ... --dry-run

Type: `string`

Schematic name
Generator name

### skipFormat

Expand Down
2 changes: 1 addition & 1 deletion docs/angular/cli/list.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ List the plugins installed in the current workspace:
nx list
```

List the schematics and builders available in the `@nrwl/web` plugin if it is installed (If the plugin is not installed `nx` will show advice on how to add it to your workspace):
List the generators and executors available in the `@nrwl/web` plugin if it is installed (If the plugin is not installed `nx` will show advice on how to add it to your workspace):

```bash
nx list @nrwl/web
Expand Down
2 changes: 1 addition & 1 deletion docs/node/api-angular/generators/move.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,4 +62,4 @@ Default: `true`

Type: `boolean`

Should the schematic update the import path to reflect the new location?
Should the generator update the import path to reflect the new location?
2 changes: 1 addition & 1 deletion docs/node/api-angular/generators/stories.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ nx g stories ... --dry-run

Type: `boolean`

Automatically generate \*.spec.ts files in the cypress e2e app generated by the cypress-configure schematic
Automatically generate \*.spec.ts files in the cypress e2e app generated by the cypress-configure generator

### name

Expand Down
4 changes: 2 additions & 2 deletions docs/node/api-angular/generators/storybook-configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,13 +28,13 @@ nx g storybook-configuration ... --dry-run

Type: `boolean`

Run the cypress-configure schematic
Run the cypress-configure generator

### generateCypressSpecs

Type: `boolean`

Automatically generate \*.spec.ts files in the cypress e2e app generated by the cypress-configure schematic
Automatically generate \*.spec.ts files in the cypress e2e app generated by the cypress-configure generator

### generateStories

Expand Down
2 changes: 1 addition & 1 deletion docs/node/api-nest/generators/class.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ Flag to indicate if a directory is created.

Type: `string`

The name of generated schematic
The name of generated generator

### project

Expand Down
2 changes: 1 addition & 1 deletion docs/node/api-nest/generators/controller.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ Flag to indicate if a directory is created.

Type: `string`

The name of generated schematic
The name of generated generator

### project

Expand Down
2 changes: 1 addition & 1 deletion docs/node/api-nest/generators/decorator.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ Flag to indicate if a directory is created.

Type: `string`

The name of generated schematic
The name of generated generator

### project

Expand Down
2 changes: 1 addition & 1 deletion docs/node/api-nest/generators/filter.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ Flag to indicate if a directory is created.

Type: `string`

The name of generated schematic
The name of generated generator

### project

Expand Down
2 changes: 1 addition & 1 deletion docs/node/api-nest/generators/gateway.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ Flag to indicate if a directory is created.

Type: `string`

The name of generated schematic
The name of generated generator

### project

Expand Down
2 changes: 1 addition & 1 deletion docs/node/api-nest/generators/guard.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ Flag to indicate if a directory is created.

Type: `string`

The name of generated schematic
The name of generated generator

### project

Expand Down
2 changes: 1 addition & 1 deletion docs/node/api-nest/generators/interceptor.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ Flag to indicate if a directory is created.

Type: `string`

The name of generated schematic
The name of generated generator

### project

Expand Down
2 changes: 1 addition & 1 deletion docs/node/api-nest/generators/interface.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ Flag to indicate if a directory is created.

Type: `string`

The name of generated schematic
The name of generated generator

### project

Expand Down
2 changes: 1 addition & 1 deletion docs/node/api-nest/generators/middleware.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ Flag to indicate if a directory is created.

Type: `string`

The name of generated schematic
The name of generated generator

### project

Expand Down
2 changes: 1 addition & 1 deletion docs/node/api-nest/generators/module.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ Flag to indicate if a directory is created.

Type: `string`

The name of generated schematic
The name of generated generator

### project

Expand Down
2 changes: 1 addition & 1 deletion docs/node/api-nest/generators/pipe.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ Flag to indicate if a directory is created.

Type: `string`

The name of generated schematic
The name of generated generator

### project

Expand Down
2 changes: 1 addition & 1 deletion docs/node/api-nest/generators/provider.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ Flag to indicate if a directory is created.

Type: `string`

The name of generated schematic
The name of generated generator

### project

Expand Down
2 changes: 1 addition & 1 deletion docs/node/api-nest/generators/resolver.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ Flag to indicate if a directory is created.

Type: `string`

The name of generated schematic
The name of generated generator

### project

Expand Down
Loading

0 comments on commit 93ebc83

Please sign in to comment.