[specs] add documentation test - #8929
Merged
Merged
Conversation
added 2 commits
November 4, 2025 13:58
iscai-msft
requested review from
AlitzelMendez,
bterlson,
chrisradek,
markcowl,
timotheeguerin and
witemple-msft
as code owners
November 4, 2025 18:59
Contributor
|
All changed packages have been documented.
|
Collaborator
|
You can try these changes here
|
msyyc
reviewed
Nov 5, 2025
tadelesh
reviewed
Nov 6, 2025
1 task
added 2 commits
November 11, 2025 13:08
timotheeguerin
approved these changes
Nov 11, 2025
tadelesh
approved these changes
Nov 12, 2025
github-merge-queue Bot
pushed a commit
that referenced
this pull request
Dec 11, 2025
Fix https://teams.microsoft.com/l/message/19:b97d98e6d22c41e0970a1150b484d935@thread.skype/1762191788524?tenantId=72f988bf-86f1-41af-91ab-2d7cd011db47&groupId=3e17dcb0-4257-4a30-b843-77f47f1d4121&parentMessageId=1762191788524&teamName=Azure%20SDK&channelName=Language%20-%20Python&createdTime=1762191788524 - The indent logic is more and more complicated so we must add test case to cover related scenarios. Then I introduce local specs to cover the target docstring scenarios in this PR. - local test specs: https://github.com/Azure/autorest.python/pull/3258/files#diff-11c3177c467ef6e1428ddb7c9180ad769cf3d5596f95b4ae33c6bfb6e32b8898 and here is generated sdk docstring: https://github.com/Azure/autorest.python/pull/3258/files#diff-4ca5eea376710573c60f99fba775abf18df7302a8871df4cd74aed290e97175b **NOTE**: If Typespec author add `\n` by themselves in original docstring (e.g. [here](https://github.com/Azure/azure-rest-api-specs-pr/blob/4a11877293189d99a93774a58d2e340fc8cdf6d2/specification/ai/Azure.AI.Projects/.external-readonly/azure.openai.v1.typespec/models/responses.tsp#L17-L27)), this PR still can't resolve indent issue. But just need to give up the line break like this [commit](Azure/azure-rest-api-specs-pr@6cecfc0), the issue of Python SDK docstring could be avoided. pending on: - [x] #8929
7 tasks
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 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.
No description provided.