Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[ServiceBus] Expand **kwargs in both sync and async APIs to improve intellisense #11685

Closed
yunhaoling opened this issue May 28, 2020 · 2 comments · Fixed by #22353
Closed

[ServiceBus] Expand **kwargs in both sync and async APIs to improve intellisense #11685

yunhaoling opened this issue May 28, 2020 · 2 comments · Fixed by #22353
Assignees
@swathipil
Labels
Client This issue points to a problem in the data-plane of the library. Messaging Messaging crew MQ This issue is part of a "milestone of quality" initiative. Service Bus
Milestone
Backlog

Comments

@yunhaoling
Copy link
Contributor

yunhaoling commented May 28, 2020 •
edited
Loading

In current public async API, kwargs are not expanded which means only required parameters shows up when IDE/Editor try to do intellisense stuff -- auto-code-complete and hint.

To make intellisense work better, expand (param, **kwargs) to (param1, *, kwarg1=default, kwarg2=default, ...) in async APIs.

not applicable for sync due to the compatibility with py2.7
@ghost ghost added the needs-triage Workflow: This is a new issue that needs to be triaged to the appropriate team. label May 28, 2020
@yunhaoling yunhaoling changed the title [ServiceBus] Expand **kwargs in async APIs [ServiceBus] Expand **kwargs in async APIs to improve intellisense May 28, 2020
@yunhaoling yunhaoling added Client This issue points to a problem in the data-plane of the library. Service Bus labels May 28, 2020
@ghost ghost removed the needs-triage Workflow: This is a new issue that needs to be triaged to the appropriate team. label May 28, 2020
@yunhaoling yunhaoling added this to the [2020] July milestone May 28, 2020
@richardpark-msft
Copy link
Member

Short of being able to remove Python 2.7 perhaps we can introduce some newlines or something into the text between the individual keyword args?

That would at least help with readability - it's a huge block of fairly undelimited text otherwise.

@KieranBrantnerMagee KieranBrantnerMagee self-assigned this Jun 10, 2020
@KieranBrantnerMagee
Copy link
Member

Bumping milestone as we're addressing this incrementally (redoing kwargs/typing as we touch components of the code) to continue tracking this work.

openapi-sdkautomation bot pushed a commit to AzureSDKAutomation/azure-sdk-for-python that referenced this issue Dec 8, 2020
CodeGen from PR 11685 in Azure/azure-rest-api-specs
3f49e9a 
OSSRDBMS Swagger completeness related changes (Azure#11685)

* OSSRDBMS Swagger completeness related changes

* OSSRDBMS Swagger completeness related changes

* OSSRDBMS Swagger completeness related changes

* OSSRDBMS Swagger completeness related changes
@lmazuel lmazuel added the Messaging Messaging crew label Apr 12, 2021
@yunhaoling yunhaoling added the MQ This issue is part of a "milestone of quality" initiative. label Oct 5, 2021
@yunhaoling yunhaoling changed the title [ServiceBus] Expand **kwargs in async APIs to improve intellisense [ServiceBus] Expand **kwargs in both sync and async APIs to improve intellisense Nov 16, 2021
@yunhaoling yunhaoling assigned swathipil and unassigned yunhaoling Nov 16, 2021
@swathipil swathipil mentioned this issue Jan 6, 2022
Merged
@github-actions github-actions bot locked and limited conversation to collaborators Apr 12, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees

@swathipil swathipil

Labels
Client This issue points to a problem in the data-plane of the library. Messaging Messaging crew MQ This issue is part of a "milestone of quality" initiative. Service Bus
Projects
None yet
Milestone
Backlog
Development

Successfully merging a pull request may close this issue.

[ServiceBus] expand kwargs in public API swathipil/azure-sdk-for-python
5 participants
@lmazuel @KieranBrantnerMagee @yunhaoling @richardpark-msft @swathipil