Skip to content

docs: add generation-subdir usage examples - #11133

Merged
Yuchao Yan (msyyc) merged 5 commits into
mainfrom
docs/generation-subdir-examples
Jul 2, 2026
Merged

Yuchao Yan (msyyc) merged 5 commits into
mainfrom
docs/generation-subdir-examples

Conversation

@msyyc

@msyyc Yuchao Yan (msyyc) commented Jul 1, 2026 •

Copy link
Copy Markdown
Contributor

Summary

SDK users were confused about the generation-subdir emitter option. This expands its description in emitter/src/lib.ts with an explanation and a concrete tspconfig.yaml example (based on azure-storage-blob), then regenerates the docs.

Changes

  • Expanded the generation-subdir description in emitter/src/lib.ts.
  • Regenerated README.md and the website reference emitter.md via npm run regen-docs.
  • Added a CONTRIBUTING.md section explaining that emitter option docs are auto-generated from lib.ts and must be regenerated with npm run build && npm run regen-docs.

for https://github.com/Azure/azure-sdk-pr/issues/2619

@pkg-pr-new

pkg-pr-new Bot commented Jul 1, 2026 •

Copy link
Copy Markdown

Open in StackBlitz

npm i https://pkg.pr.new/@typespec/http-client-python@11133

commit: 3be2e60

@github-actions

github-actions Bot commented Jul 1, 2026 •

Copy link
Copy Markdown
Contributor

All changed packages have been documented.

  • ✅ @typespec/http-client-python
Show changes

@typespec/http-client-python - internal ✏️

Add usage examples for the generation-subdir emitter option in the docs.

@azure-sdk-automation

azure-sdk-automation Bot commented Jul 1, 2026 •

Copy link
Copy Markdown

You can try these changes here

🛝 Playground 🌐 Website 🛝 VSCode Extension

@msyyc
Yuchao Yan (msyyc) added this pull request to the merge queue Jul 1, 2026
Merged via the queue into main with commit c18420d Jul 2, 2026
49 checks passed
@msyyc
Yuchao Yan (msyyc) deleted the docs/generation-subdir-examples branch July 2, 2026 00:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

emitter:client:python Issue for the Python client emitter: @typespec/http-client-python meta:website TypeSpec.io updates

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants