pulumi/sdk
Will Jones 21a7b501b4
Improve TypeDocs for `sdk/nodejs/automation` (#16616)
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.


![image](https://github.com/pulumi/pulumi/assets/163793/b6ab94cf-74d7-4c6d-a2e1-df737c184794)

![image](https://github.com/pulumi/pulumi/assets/163793/783dd060-67a1-487a-a683-2c8a94ac3d86)
2024-07-10 17:22:24 +00:00
..
go Change parameterization to be bytes based (#16606) 2024-07-10 11:15:35 +00:00
nodejs Improve TypeDocs for `sdk/nodejs/automation` (#16616) 2024-07-10 17:22:24 +00:00
proto/go Change parameterization to be bytes based (#16606) 2024-07-10 11:15:35 +00:00
python Change parameterization to be bytes based (#16606) 2024-07-10 11:15:35 +00:00
.version Prepare for v3.123.0 release (#16607) 2024-07-10 08:10:11 +00:00
README.md Cleanup sdk/README.md 2023-01-03 17:12:12 -05:00
go.mod Query language runtime for options during “pulumi new” (#16346) 2024-06-17 17:10:55 +00:00
go.sum Query language runtime for options during “pulumi new” (#16346) 2024-06-17 17:10:55 +00:00
version.go Move .version to /sdk and embed it (#15185) 2024-01-19 14:11:17 +00:00

README.md

Pulumi Language SDKs

This directory contains Pulumi SDKs for the following languages:

See the respective READMEs for information about installing and using these libraries.

The language providers work by implementing gRPC interfaces defined in the top level directory proto.