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

[suggest-fix] Run test PRs on azure-docs-sdk-python-363 (part 1) #1931

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

[suggest-fix] Run test PRs on azure-docs-sdk-python-363 (part 1) #1931

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
3 changes: 2 additions & 1 deletion docs-ref-autogen/azure-containerregistry/azure.containerregistry.ContainerRegistryClient.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ constructor:
description: 'URL to use for credential authentication with AAD. Its value could
be

"[https://management.azure.com](https://management.azure.com)", "[https://management.chinacloudapi.cn](https://management.chinacloudapi.cn)"
"`https://management.azure.com`", "[https://management.chinacloudapi.cn](https://management.chinacloudapi.cn)"
Copy link
Contributor

@nickwalkmsft nickwalkmsft Aug 6, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These proposals (backtick wrapping and zapping management.azure.com links specifically) are drowning out any potentially interesting ones, can they be disabled and the tool rerun to see what the output looks like?

  • These URLs are not actually links in the source, I believe the docs translator tool detects URLs in description fields and renders them as markdown links. For this small set of URLs that appears frequently, if the link-fixer is just going to remove them (and why is it only removing management.azure.com and not the others?), I think we'd be better off just not putting them in. Maybe we can detect and skip in the translator.
  • Wrapping of URLs in backticks might be something we can do in the translator as well, at least for description fields (I don't think they get detected elsewhere, which is why they aren't Markdown links in fields like syntax and defaultvalue). The convention in the source appears to be to put them in double-quotes instead; having both together looks kind of funky and sort of defeats the point I think.

(Link to relevant translator source for posterity)

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looping in @junshi356 for opinions/input on py2docfx.

Jun, the context here is that we are looking into running the automated link-checker on ref repos. We're aware that any changes committed here would be eliminated with the next pipeline run, this is just an experiment at this point.

Here in the python repo we see many instances of a couple of the same items (listed above). Would these be feasible changes in py2docfx?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi, @nickwalkmsft sorry for the delay, the github notification didn't reach my MSFT mail. All API yaml documents in Python reference repos are purged then added again in each of the pipeline execution, so manual changes will be overwritten as long as the converter or the source package isn't updated. I think it's the right way to add the fix into py2docfx converter to make it persistent and valid for future documents.

or

"[https://management.usgovcloudapi.net](https://management.usgovcloudapi.net)".
Expand Down Expand Up @@ -471,3 +471,4 @@ methods:
- type: azure.containerregistry.DigestValidationError
description: If the server-computed digest does not match the client-computed
digest.

3 changes: 2 additions & 1 deletion ...f-autogen/azure-containerregistry/azure.containerregistry.aio.ContainerRegistryClient.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ constructor:
description: 'URL to use for credential authentication with AAD. Its value could
be

"[https://management.azure.com](https://management.azure.com)", "[https://management.chinacloudapi.cn](https://management.chinacloudapi.cn)"
"`https://management.azure.com`", "[https://management.chinacloudapi.cn](https://management.chinacloudapi.cn)"
or

"[https://management.usgovcloudapi.net](https://management.usgovcloudapi.net)".
Expand Down Expand Up @@ -446,3 +446,4 @@ methods:
- type: azure.containerregistry.DigestValidationError
description: If the server-computed digest does not match the client-computed
digest.

7 changes: 4 additions & 3 deletions docs-ref-autogen/azure-mgmt-apicenter/azure.mgmt.apicenter.ApiCenterMgmtClient.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ inheritances:
summary: Azure API Center Resource Provider.
constructor:
syntax: 'ApiCenterMgmtClient(credential: TokenCredential, subscription_id: str,
base_url: str = ''https://management.azure.com'', **kwargs: Any)'
base_url: str = ''`https://management.azure.com`'', **kwargs: Any)'
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

syntax gets rendered to code blocks, we don't want anything modified in these.

parameters:
- name: credential
description: Credential needed for the client to connect to Azure. Required.
Expand All @@ -21,8 +21,8 @@ constructor:
types:
- <xref:str>
- name: base_url
description: Service URL. Default value is "[https://management.azure.com](https://management.azure.com)".
defaultValue: https://management.azure.com
description: Service URL. Default value is "`https://management.azure.com`".
defaultValue: `https://management.azure.com`
types:
- <xref:str>
keywordOnlyParameters:
Expand Down Expand Up @@ -80,3 +80,4 @@ methods:
- uid: azure.mgmt.apicenter.ApiCenterMgmtClient.close
name: close
signature: close() -> None

7 changes: 4 additions & 3 deletions docs-ref-autogen/azure-mgmt-apicenter/azure.mgmt.apicenter.aio.ApiCenterMgmtClient.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ inheritances:
summary: Azure API Center Resource Provider.
constructor:
syntax: 'ApiCenterMgmtClient(credential: AsyncTokenCredential, subscription_id:
str, base_url: str = ''https://management.azure.com'', **kwargs: Any)'
str, base_url: str = ''`https://management.azure.com`'', **kwargs: Any)'
parameters:
- name: credential
description: Credential needed for the client to connect to Azure. Required.
Expand All @@ -21,8 +21,8 @@ constructor:
types:
- <xref:str>
- name: base_url
description: Service URL. Default value is "[https://management.azure.com](https://management.azure.com)".
defaultValue: https://management.azure.com
description: Service URL. Default value is "`https://management.azure.com`".
defaultValue: `https://management.azure.com`
types:
- <xref:str>
keywordOnlyParameters:
Expand Down Expand Up @@ -80,3 +80,4 @@ methods:
- uid: azure.mgmt.apicenter.aio.ApiCenterMgmtClient.close
name: close
signature: async close() -> None

7 changes: 4 additions & 3 deletions ...lianceautomation/azure.mgmt.appcomplianceautomation.AppComplianceAutomationMgmtClient.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,16 +8,16 @@ inheritances:
summary: App Compliance Automation Tool for Microsoft 365 API spec.
constructor:
syntax: 'AppComplianceAutomationMgmtClient(credential: TokenCredential, base_url:
str = ''https://management.azure.com'', **kwargs: Any)'
str = ''`https://management.azure.com`'', **kwargs: Any)'
parameters:
- name: credential
description: Credential needed for the client to connect to Azure. Required.
isRequired: true
types:
- <xref:azure.core.credentials.TokenCredential>
- name: base_url
description: Service URL. Default value is "[https://management.azure.com](https://management.azure.com)".
defaultValue: https://management.azure.com
description: Service URL. Default value is "`https://management.azure.com`".
defaultValue: `https://management.azure.com`
types:
- <xref:str>
keywordOnlyParameters:
Expand Down Expand Up @@ -67,3 +67,4 @@ methods:
- uid: azure.mgmt.appcomplianceautomation.AppComplianceAutomationMgmtClient.close
name: close
signature: close() -> None

7 changes: 4 additions & 3 deletions ...ceautomation/azure.mgmt.appcomplianceautomation.aio.AppComplianceAutomationMgmtClient.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,16 +8,16 @@ inheritances:
summary: App Compliance Automation Tool for Microsoft 365 API spec.
constructor:
syntax: 'AppComplianceAutomationMgmtClient(credential: AsyncTokenCredential, base_url:
str = ''https://management.azure.com'', **kwargs: Any)'
str = ''`https://management.azure.com`'', **kwargs: Any)'
parameters:
- name: credential
description: Credential needed for the client to connect to Azure. Required.
isRequired: true
types:
- <xref:azure.core.credentials_async.AsyncTokenCredential>
- name: base_url
description: Service URL. Default value is "[https://management.azure.com](https://management.azure.com)".
defaultValue: https://management.azure.com
description: Service URL. Default value is "`https://management.azure.com`".
defaultValue: `https://management.azure.com`
types:
- <xref:str>
keywordOnlyParameters:
Expand Down Expand Up @@ -67,3 +67,4 @@ methods:
- uid: azure.mgmt.appcomplianceautomation.aio.AppComplianceAutomationMgmtClient.close
name: close
signature: async close() -> None

7 changes: 4 additions & 3 deletions ...tion/azure.mgmt.appconfiguration.v2022_03_01_preview.AppConfigurationManagementClient.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ inheritances:
summary: AppConfigurationManagementClient.
constructor:
syntax: 'AppConfigurationManagementClient(credential: TokenCredential, subscription_id:
str, base_url: str = ''https://management.azure.com'', **kwargs: Any)'
str, base_url: str = ''`https://management.azure.com`'', **kwargs: Any)'
parameters:
- name: credential
description: Credential needed for the client to connect to Azure. Required.
Expand All @@ -21,8 +21,8 @@ constructor:
types:
- <xref:str>
- name: base_url
description: Service URL. Default value is "[https://management.azure.com](https://management.azure.com)".
defaultValue: https://management.azure.com
description: Service URL. Default value is "`https://management.azure.com`".
defaultValue: `https://management.azure.com`
types:
- <xref:str>
keywordOnlyParameters:
Expand Down Expand Up @@ -67,3 +67,4 @@ methods:
- uid: azure.mgmt.appconfiguration.v2022_03_01_preview.AppConfigurationManagementClient.close
name: close
signature: close() -> None

7 changes: 4 additions & 3 deletions .../azure.mgmt.appconfiguration.v2022_03_01_preview.aio.AppConfigurationManagementClient.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ inheritances:
summary: AppConfigurationManagementClient.
constructor:
syntax: 'AppConfigurationManagementClient(credential: AsyncTokenCredential, subscription_id:
str, base_url: str = ''https://management.azure.com'', **kwargs: Any)'
str, base_url: str = ''`https://management.azure.com`'', **kwargs: Any)'
parameters:
- name: credential
description: Credential needed for the client to connect to Azure. Required.
Expand All @@ -21,8 +21,8 @@ constructor:
types:
- <xref:str>
- name: base_url
description: Service URL. Default value is "[https://management.azure.com](https://management.azure.com)".
defaultValue: https://management.azure.com
description: Service URL. Default value is "`https://management.azure.com`".
defaultValue: `https://management.azure.com`
types:
- <xref:str>
keywordOnlyParameters:
Expand Down Expand Up @@ -67,3 +67,4 @@ methods:
- uid: azure.mgmt.appconfiguration.v2022_03_01_preview.aio.AppConfigurationManagementClient.close
name: close
signature: async close() -> None

7 changes: 4 additions & 3 deletions ...onfiguration/azure.mgmt.appconfiguration.v2022_05_01.AppConfigurationManagementClient.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ inheritances:
summary: AppConfigurationManagementClient.
constructor:
syntax: 'AppConfigurationManagementClient(credential: TokenCredential, subscription_id:
str, base_url: str = ''https://management.azure.com'', **kwargs: Any)'
str, base_url: str = ''`https://management.azure.com`'', **kwargs: Any)'
parameters:
- name: credential
description: Credential needed for the client to connect to Azure. Required.
Expand All @@ -21,8 +21,8 @@ constructor:
types:
- <xref:str>
- name: base_url
description: Service URL. Default value is "[https://management.azure.com](https://management.azure.com)".
defaultValue: https://management.azure.com
description: Service URL. Default value is "`https://management.azure.com`".
defaultValue: `https://management.azure.com`
types:
- <xref:str>
keywordOnlyParameters:
Expand Down Expand Up @@ -64,3 +64,4 @@ methods:
- uid: azure.mgmt.appconfiguration.v2022_05_01.AppConfigurationManagementClient.close
name: close
signature: close() -> None

7 changes: 4 additions & 3 deletions ...guration/azure.mgmt.appconfiguration.v2022_05_01.aio.AppConfigurationManagementClient.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ inheritances:
summary: AppConfigurationManagementClient.
constructor:
syntax: 'AppConfigurationManagementClient(credential: AsyncTokenCredential, subscription_id:
str, base_url: str = ''https://management.azure.com'', **kwargs: Any)'
str, base_url: str = ''`https://management.azure.com`'', **kwargs: Any)'
parameters:
- name: credential
description: Credential needed for the client to connect to Azure. Required.
Expand All @@ -21,8 +21,8 @@ constructor:
types:
- <xref:str>
- name: base_url
description: Service URL. Default value is "[https://management.azure.com](https://management.azure.com)".
defaultValue: https://management.azure.com
description: Service URL. Default value is "`https://management.azure.com`".
defaultValue: `https://management.azure.com`
types:
- <xref:str>
keywordOnlyParameters:
Expand Down Expand Up @@ -64,3 +64,4 @@ methods:
- uid: azure.mgmt.appconfiguration.v2022_05_01.aio.AppConfigurationManagementClient.close
name: close
signature: async close() -> None

7 changes: 4 additions & 3 deletions ...onfiguration/azure.mgmt.appconfiguration.v2023_03_01.AppConfigurationManagementClient.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ inheritances:
summary: AppConfigurationManagementClient.
constructor:
syntax: 'AppConfigurationManagementClient(credential: TokenCredential, subscription_id:
str, base_url: str = ''https://management.azure.com'', **kwargs: Any)'
str, base_url: str = ''`https://management.azure.com`'', **kwargs: Any)'
parameters:
- name: credential
description: Credential needed for the client to connect to Azure. Required.
Expand All @@ -21,8 +21,8 @@ constructor:
types:
- <xref:str>
- name: base_url
description: Service URL. Default value is "[https://management.azure.com](https://management.azure.com)".
defaultValue: https://management.azure.com
description: Service URL. Default value is "`https://management.azure.com`".
defaultValue: `https://management.azure.com`
types:
- <xref:str>
keywordOnlyParameters:
Expand Down Expand Up @@ -68,3 +68,4 @@ methods:
- uid: azure.mgmt.appconfiguration.v2023_03_01.AppConfigurationManagementClient.close
name: close
signature: close() -> None

7 changes: 4 additions & 3 deletions ...guration/azure.mgmt.appconfiguration.v2023_03_01.aio.AppConfigurationManagementClient.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ inheritances:
summary: AppConfigurationManagementClient.
constructor:
syntax: 'AppConfigurationManagementClient(credential: AsyncTokenCredential, subscription_id:
str, base_url: str = ''https://management.azure.com'', **kwargs: Any)'
str, base_url: str = ''`https://management.azure.com`'', **kwargs: Any)'
parameters:
- name: credential
description: Credential needed for the client to connect to Azure. Required.
Expand All @@ -21,8 +21,8 @@ constructor:
types:
- <xref:str>
- name: base_url
description: Service URL. Default value is "[https://management.azure.com](https://management.azure.com)".
defaultValue: https://management.azure.com
description: Service URL. Default value is "`https://management.azure.com`".
defaultValue: `https://management.azure.com`
types:
- <xref:str>
keywordOnlyParameters:
Expand Down Expand Up @@ -68,3 +68,4 @@ methods:
- uid: azure.mgmt.appconfiguration.v2023_03_01.aio.AppConfigurationManagementClient.close
name: close
signature: async close() -> None

7 changes: 4 additions & 3 deletions ...-ref-autogen/azure-mgmt-appcontainers/azure.mgmt.appcontainers.ContainerAppsAPIClient.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ inheritances:
summary: ContainerAppsAPIClient.
constructor:
syntax: 'ContainerAppsAPIClient(credential: TokenCredential, subscription_id: str,
base_url: str = ''https://management.azure.com'', **kwargs: Any)'
base_url: str = ''`https://management.azure.com`'', **kwargs: Any)'
parameters:
- name: credential
description: Credential needed for the client to connect to Azure. Required.
Expand All @@ -21,8 +21,8 @@ constructor:
types:
- <xref:str>
- name: base_url
description: Service URL. Default value is "[https://management.azure.com](https://management.azure.com)".
defaultValue: https://management.azure.com
description: Service URL. Default value is "`https://management.azure.com`".
defaultValue: `https://management.azure.com`
types:
- <xref:str>
keywordOnlyParameters:
Expand Down Expand Up @@ -140,3 +140,4 @@ methods:
- uid: azure.mgmt.appcontainers.ContainerAppsAPIClient.close
name: close
signature: close() -> None

7 changes: 4 additions & 3 deletions ...-autogen/azure-mgmt-appcontainers/azure.mgmt.appcontainers.aio.ContainerAppsAPIClient.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ inheritances:
summary: ContainerAppsAPIClient.
constructor:
syntax: 'ContainerAppsAPIClient(credential: AsyncTokenCredential, subscription_id:
str, base_url: str = ''https://management.azure.com'', **kwargs: Any)'
str, base_url: str = ''`https://management.azure.com`'', **kwargs: Any)'
parameters:
- name: credential
description: Credential needed for the client to connect to Azure. Required.
Expand All @@ -21,8 +21,8 @@ constructor:
types:
- <xref:str>
- name: base_url
description: Service URL. Default value is "[https://management.azure.com](https://management.azure.com)".
defaultValue: https://management.azure.com
description: Service URL. Default value is "`https://management.azure.com`".
defaultValue: `https://management.azure.com`
types:
- <xref:str>
keywordOnlyParameters:
Expand Down Expand Up @@ -140,3 +140,4 @@ methods:
- uid: azure.mgmt.appcontainers.aio.ContainerAppsAPIClient.close
name: close
signature: async close() -> None

7 changes: 4 additions & 3 deletions ...sights/azure.mgmt.applicationinsights.v2015_05_01.ApplicationInsightsManagementClient.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ inheritances:
summary: Composite Swagger for Application Insights Management Client.
constructor:
syntax: 'ApplicationInsightsManagementClient(credential: TokenCredential, subscription_id:
str, base_url: str = ''https://management.azure.com'', **kwargs: Any)'
str, base_url: str = ''`https://management.azure.com`'', **kwargs: Any)'
parameters:
- name: credential
description: Credential needed for the client to connect to Azure. Required.
Expand All @@ -21,8 +21,8 @@ constructor:
types:
- <xref:str>
- name: base_url
description: Service URL. Default value is "[https://management.azure.com](https://management.azure.com)".
defaultValue: https://management.azure.com
description: Service URL. Default value is "`https://management.azure.com`".
defaultValue: `https://management.azure.com`
types:
- <xref:str>
keywordOnlyParameters:
Expand Down Expand Up @@ -106,3 +106,4 @@ methods:
- uid: azure.mgmt.applicationinsights.v2015_05_01.ApplicationInsightsManagementClient.close
name: close
signature: close() -> None

7 changes: 4 additions & 3 deletions ...ts/azure.mgmt.applicationinsights.v2015_05_01.aio.ApplicationInsightsManagementClient.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ inheritances:
summary: Composite Swagger for Application Insights Management Client.
constructor:
syntax: 'ApplicationInsightsManagementClient(credential: AsyncTokenCredential, subscription_id:
str, base_url: str = ''https://management.azure.com'', **kwargs: Any)'
str, base_url: str = ''`https://management.azure.com`'', **kwargs: Any)'
parameters:
- name: credential
description: Credential needed for the client to connect to Azure. Required.
Expand All @@ -21,8 +21,8 @@ constructor:
types:
- <xref:str>
- name: base_url
description: Service URL. Default value is "[https://management.azure.com](https://management.azure.com)".
defaultValue: https://management.azure.com
description: Service URL. Default value is "`https://management.azure.com`".
defaultValue: `https://management.azure.com`
types:
- <xref:str>
keywordOnlyParameters:
Expand Down Expand Up @@ -106,3 +106,4 @@ methods:
- uid: azure.mgmt.applicationinsights.v2015_05_01.aio.ApplicationInsightsManagementClient.close
name: close
signature: async close() -> None

Loading