Skip to content

Commit a636645

Browse files
authored
Update doc because the dpg modular has already been set as the default (#36698)
related pr Azure/autorest.typescript#3369 Update doc because the dpg modular has already been set as the default
1 parent 8ae427d commit a636645

File tree

3 files changed

+2
-8
lines changed

3 files changed

+2
-8
lines changed

documentation/DPG-quickstart.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,6 @@ The `package name` is used when publishing to [npmjs](https://www.npmjs.com/). I
5252
options:
5353
"@azure-tools/typespec-ts":
5454
emitter-output-dir: "{output-dir}/{service-dir}/YOUR_SERVICE_FOLDER"
55-
is-modular-library: true
5655
package-details:
5756
name: YOUR_PACKAGE_NAME
5857
description: "SHORT_DESCRIPTION"

documentation/Generate-code-from-TypeSpec.md

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -36,13 +36,7 @@ You can reference these two config files to configure the Modular or RLC package
3636
- [Modular tspconfig.yaml](https://github.com/Azure/azure-rest-api-specs/blob/main/specification/contosowidgetmanager/Contoso.Management/tspconfig.yaml)
3737
- [RLC tspconfig.yaml](https://github.com/Azure/azure-rest-api-specs/blob/main/specification/contosowidgetmanager/Contoso.WidgetManager/tspconfig.yaml)
3838
39-
Please make sure `service-dir`, `emitter-output-dir`, `package-details`, `flavor`(for typespec-ts) is correctly configured. `experimental-extensible-enums` is the optional config.
40-
For control-plane SDKs, the `is-modular-library` option is true by default, while for data-plane SDKs it is false. To generate Modular libraries for data-plane SDKs, you must add
41-
```
42-
is-modular-library:true
43-
```
44-
in your tspconfig.yaml. `is-modular-library` should be set to true unless you have been explicitly instructed by the Azure SDK Architecture Board to proceed with RLC code generation.
45-
39+
Please make sure `service-dir`, `emitter-output-dir`, `package-details`, `flavor`(for typespec-ts) is correctly configured. `experimental-extensible-enums` is the optional config.The `is-modular-library` option is true by default, if you want to generate RLC libraries for data-plane SDKs, you must add `is-modular-library: false` in your tspconfig.yaml.
4640
4741
- "parameters.service-dir.default" would be `sdk/<service>`
4842
- "options.@azure-tools/typespec-ts.emitter-output-dir" would be `{output-dir}/{service-dir}/<module>`

documentation/RLC-quickstart.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,7 @@ The `package name` is used when publishing to [npmjs](https://www.npmjs.com/). I
5353
options:
5454
"@azure-tools/typespec-ts":
5555
emitter-output-dir: "{output-dir}/{service-dir}/YOUR_SERVICE_FOLDER-rest"
56+
is-modular-library: false
5657
package-details:
5758
name: YOUR_PACKAGE_NAME
5859
description: "SHORT_DESCRIPTION"

0 commit comments

Comments
 (0)