Skip to content

[Python] fix bad indent in docstring#8927

Merged
msyyc merged 5 commits intomainfrom
python-fix-docstring
Dec 11, 2025
Merged

[Python] fix bad indent in docstring#8927
msyyc merged 5 commits intomainfrom
python-fix-docstring

Conversation

@msyyc
Copy link
Contributor

@msyyc msyyc commented Nov 4, 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

NOTE:
If Typespec author add \n by themselves in original docstring (e.g. here), this PR still can't resolve indent issue. But just need to give up the line break like this commit, the issue of Python SDK docstring could be avoided.

pending on:

@github-actions
Copy link
Contributor

github-actions bot commented Nov 4, 2025

All changed packages have been documented.

  • @typespec/http-client-python
Show changes

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

Fix bad indent

@azure-sdk
Copy link
Collaborator

azure-sdk commented Nov 4, 2025

You can try these changes here

🛝 Playground 🌐 Website 🛝 VSCode Extension

@iscai-msft
Copy link
Member

I think it would be fair to add a docstring test to the specs repo, let me comment in the group and see if people are ok with that

@msyyc msyyc force-pushed the python-fix-docstring branch from 1dc3c0a to 162fd1b Compare December 10, 2025 10:24
@pkg-pr-new
Copy link

pkg-pr-new bot commented Dec 10, 2025

Open in StackBlitz

npm i https://pkg.pr.new/microsoft/typespec/@typespec/http@8927
npm i https://pkg.pr.new/microsoft/typespec/@typespec/http-client@8927

commit: 8a02467

@msyyc msyyc marked this pull request as ready for review December 10, 2025 14:02
@msyyc msyyc enabled auto-merge December 11, 2025 06:38
@msyyc msyyc added this pull request to the merge queue Dec 11, 2025
Merged via the queue into main with commit 9aea80e Dec 11, 2025
38 checks passed
@msyyc msyyc deleted the python-fix-docstring branch December 11, 2025 17:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants