mirror of https://github.com/pulumi/pulumi.git
21a7b501b4
This commit improves the TypeScript TypeDocs for `automation` modules in
the NodeJS SDK. Specifically:
* It adds documentation to interfaces, properties, etc. that are missing
it.
* It transforms would-be TypeDoc comments erroneously written using
either `/*` (a single asterisk) or `//` (a normal line comment) to
actual TypeDoc comments.
* It standardises on TypeDoc's `{@link Name}` syntax for linking
identifiers, as opposed to the mixture of backticks and square brackets
we have today. This helps IDEs as well as (hopefully) improving any
rendered documentation.
* It fixes typos and generally cleans up the formatting here and there,
as well as introducing more consistency where the same concepts crop up
in multiple places.
|
||
|---|---|---|
| .. | ||
| cmd.ts | ||
| config.ts | ||
| errors.ts | ||
| events.ts | ||
| index.ts | ||
| localWorkspace.ts | ||
| minimumVersion.ts | ||
| projectSettings.ts | ||
| remoteStack.ts | ||
| remoteWorkspace.ts | ||
| server.ts | ||
| stack.ts | ||
| stackSettings.ts | ||
| tag.ts | ||
| workspace.ts | ||