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.

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

Function kwargs not rendering on docs.ms.com #14990

Closed
scbedd opened this issue Nov 3, 2020 · 1 comment
Closed

Function kwargs not rendering on docs.ms.com #14990

scbedd opened this issue Nov 3, 2020 · 1 comment
Assignees
Labels
Central-EngSys This issue is owned by the Engineering System team. Docs

Comments

@scbedd
Copy link
Member

scbedd commented Nov 3, 2020

Boils down to during processing within the sphinx-docfx-yaml extension, we're seeing the following earning when we enable debug output:

Can't get argspec for <class 'function'>: azure.mgmt.storage.v2015_06_15.aio.operations.StorageAccountsOperations.begin_create
Can't get argspec for <class 'function'>: azure.mgmt.storage.v2015_06_15.aio.operations.StorageAccountsOperations.check_name_availability

I know it's firing from extension.py, but I don't have a root cause as to WHY this is yet.

Note that class kwargs aren't having this same problem.

@scbedd scbedd added Docs EngSys This issue is impacting the engineering system. labels Nov 3, 2020
@scbedd scbedd self-assigned this Nov 3, 2020
@scbedd scbedd added Central-EngSys This issue is owned by the Engineering System team. and removed EngSys This issue is impacting the engineering system. labels Nov 3, 2020
@scbedd
Copy link
Member Author

scbedd commented Nov 10, 2020

After spending a bunch more time with this, I believe this issue is at least twofold. Context here is that Johan raised this as a general issue. It both IS and ISN'T a general issue. We definitely do document some function keyword arguments. The problem is we don't seem to be doing it consistently. There also isn't a great way to programatically pull this detail out of the rendered docs.

For the specific issue that Johan raised, like here...

You'll notice that SOME keyword params are rendered. And NONE of the param types are. That's because this doc string is broken in general.

The sphinx itself not being able to parse the doc string for azure-storage-blob. See our own github.io.

image

I am going to try a couple local sphinx runs. I'm thinking the easy answer will be to replace the " with ', but I'm digging and will submit a PR that resolves this on the packages that I can find that do this.

As for the "only some" function keyword params, I do have another PR that addresses other issues we've found as part of this investigation.

@scbedd scbedd closed this as completed Nov 12, 2020
openapi-sdkautomation bot pushed a commit to AzureSDKAutomation/azure-sdk-for-python that referenced this issue Jun 25, 2021
[Python] track2 config  (Azure#14990)

* authorization

* automation

* recoveryservices

* logic

* notificationhubs

* search
openapi-sdkautomation bot pushed a commit to AzureSDKAutomation/azure-sdk-for-python that referenced this issue Jun 25, 2021
[Python] track2 config  (Azure#14990)

* authorization

* automation

* recoveryservices

* logic

* notificationhubs

* search
openapi-sdkautomation bot pushed a commit to AzureSDKAutomation/azure-sdk-for-python that referenced this issue Jun 25, 2021
[Python] track2 config  (Azure#14990)

* authorization

* automation

* recoveryservices

* logic

* notificationhubs

* search
openapi-sdkautomation bot pushed a commit to AzureSDKAutomation/azure-sdk-for-python that referenced this issue Jun 25, 2021
[Python] track2 config  (Azure#14990)

* authorization

* automation

* recoveryservices

* logic

* notificationhubs

* search
openapi-sdkautomation bot pushed a commit to AzureSDKAutomation/azure-sdk-for-python that referenced this issue Jun 25, 2021
[Python] track2 config  (Azure#14990)

* authorization

* automation

* recoveryservices

* logic

* notificationhubs

* search
openapi-sdkautomation bot pushed a commit to AzureSDKAutomation/azure-sdk-for-python that referenced this issue Jun 25, 2021
[Python] track2 config  (Azure#14990)

* authorization

* automation

* recoveryservices

* logic

* notificationhubs

* search
msyyc pushed a commit that referenced this issue Jul 13, 2021
* CodeGen from PR 14990 in Azure/azure-rest-api-specs
[Python] track2 config  (#14990)

* authorization

* automation

* recoveryservices

* logic

* notificationhubs

* search

* version,CHANGELOG

* test

* test config

Co-authored-by: SDKAuto <sdkautomation@microsoft.com>
Co-authored-by: PythonSdkPipelines <PythonSdkPipelines>
Co-authored-by: Zed <601306339@qq.com>
rakshith91 pushed a commit to rakshith91/azure-sdk-for-python that referenced this issue Jul 16, 2021
* CodeGen from PR 14990 in Azure/azure-rest-api-specs
[Python] track2 config  (Azure#14990)

* authorization

* automation

* recoveryservices

* logic

* notificationhubs

* search

* version,CHANGELOG

* test

* test config

Co-authored-by: SDKAuto <sdkautomation@microsoft.com>
Co-authored-by: PythonSdkPipelines <PythonSdkPipelines>
Co-authored-by: Zed <601306339@qq.com>
@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.
Labels
Central-EngSys This issue is owned by the Engineering System team. Docs
Projects
None yet
Development

No branches or pull requests

1 participant