search

Azure / azure-sdk-for-python

This repository is for active development of the Azure SDK for Python. For consumers of the SDK we recommend visiting our public developer docs at https://docs.microsoft.com/python/azure/ or our versioned developer docs at https://azure.github.io/azure-sdk-for-python.
MIT License
4.35k stars 2.71k forks source link

Reference url of Container class is incorrect #35313

Open Wisteria30 opened 2 months ago

Wisteria30 commented 2 months ago

Type of issue

Typo

Description

The JobTemplate documentation for Azure Container Apps Jobs is incomplete.

"Keyword-Only Parameters" refers to the Container class of containers in the official Python documentation, but in fact I thought "azure.mgmt.appcontainers. Container" should be linked.

Before: https://docs.python.org/3/library/typing.html#typing.Container After: https://learn.microsoft.com/en-us/python/api/azure-mgmt-appcontainers/azure.mgmt.appcontainers.models.container?view=azure- python

Translated with www.DeepL.com/Translator (free version)

Page URL

https://learn.microsoft.com/en-us/python/api/azure-mgmt-appcontainers/azure.mgmt.appcontainers.models.jobtemplate?view=azure-python

Content source URL

https://github.com/MicrosoftDocs/azure-docs-sdk-python/blob/main/docs-ref-autogen/azure-mgmt-appcontainers/azure.mgmt.appcontainers.models.JobTemplate.yml

Document Version Independent Id

476cd042-f8b4-0b6d-4fbd-08a81c3f4411

Article author

@lmazuel

Metadata

github-actions[bot] commented 2 months ago

Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc @macolso.

ChenxiJiang333 commented 2 weeks ago

It might be the issue during the rendering, @rohit-ganguly could you help take a look at this?

rohit-ganguly commented 6 days ago

Investigating, thanks for the ping

rohit-ganguly commented 6 days ago

@Wisteria30 Thanks for opening this issue! We're in the process of upgrading our Sphinx version from 6 to 7+ on our Microsoft Learn docs. When generating docs with v7 locally, we see the proper cross-reference: image

cc @ChenxiJiang333 @kristapratico @lmazuel @kyle-patterson FYI

github-actions[bot] commented 6 days ago

Hi @Wisteria30. Thank you for opening this issue and giving us the opportunity to assist. We believe that this has been addressed. If you feel that further discussion is needed, please add a comment with the text "/unresolve" to remove the "issue-addressed" label and continue the conversation.