Skip to content

Use full name when cross referencing a class from a different module #40687

@kexugit

Description

@kexugit
  • Package Name: azure-storage-queue
  • Package Version: 12.12.0
  • Operating System:
  • Python Version:

Describe the bug
Azure API reference doc has unresolved xref links (example). This is because when cross referencing classes from another module, full class name was not used (example).

According to EngHub FAQ, when partners are cross referencing a class that does not exist in the same module, the full name of referred class is required for resolving this xref correctly.

To Reproduce
Steps to reproduce the behavior:

  1. Go to https://learn.microsoft.com/en-us/python/api/azure-storage-queue//azure.storage.queue.aio.queueclient?view=azure-python&branch=main#keyword-only-parameters
  2. Notice the unresolved xref links.

Expected behavior
Xref links are properly resolved.

Screenshots
If applicable, add screenshots to help explain your problem.

Additional context
Add any other context about the problem here.

Metadata

Metadata

Labels

ClientThis issue points to a problem in the data-plane of the library.Service AttentionWorkflow: This issue is responsible by Azure service team.StorageStorage Service (Queues, Blobs, Files)customer-reportedIssues that are reported by GitHub users external to the Azure organization.needs-team-attentionWorkflow: This issue needs attention from Azure service team or SDK teamquestionThe issue doesn't require a change to the product in order to be resolved. Most issues start as that

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions