Update doc because the dpg modular has already been set as the default #36698
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
MaryGao
approved these changes
Nov 24, 2025
Copilot finished reviewing on behalf of
MaryGao
November 24, 2025 05:26
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the documentation to reflect that modular library generation (is-modular-library: true) is now the default behavior in the TypeSpec TypeScript emitter, following the changes made in Azure/autorest.typescript#3369.
Key Changes:
- Updated documentation to clarify that
is-modular-librarydefaults totrue - Removed redundant
is-modular-library: truefrom DPG (modular) quickstart examples - Added explicit
is-modular-library: falseto RLC quickstart examples to opt out of the default
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| documentation/RLC-quickstart.md | Added is-modular-library: false to the tspconfig.yaml example to explicitly opt into RLC generation since modular is now the default |
| documentation/Generate-code-from-TypeSpec.md | Updated the explanation to reflect that is-modular-library is now true by default, and users must explicitly set it to false for RLC libraries |
| documentation/DPG-quickstart.md | Removed the now-redundant is-modular-library: true configuration since it's the default value |
| ``` | ||
| 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. | ||
| 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. |
There was a problem hiding this comment.
Missing space after period. There should be a space between sentences for better readability.
Suggested change
| 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. | |
| 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. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
related pr Azure/autorest.typescript#3369
Update doc because the dpg modular has already been set as the default