Skip to content

[Storage] Fix metadata typehint in file-share #35505

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

Conversation

vincenttran-msft
Copy link
Member

This change is to fix the following behavior:
:keyword dict(str,str) metadata: renders as:
image

:keyword dict[str, str] renders as:
image
(loses ability to imply optionality??)

So now we are moving towards:

:keyword metadata:
            Name-value pairs associated with the share as metadata.
:paramtype metadata: Optional[dict[str, str]]

To get the correct rendering:
image

@github-actions github-actions bot added the Storage Storage Service (Queues, Blobs, Files) label May 6, 2024
@azure-sdk
Copy link
Collaborator

API change check

APIView has identified API level changes in this PR and created following API reviews.

azure-storage-file-share

@vincenttran-msft vincenttran-msft merged commit 4e51ac6 into Azure:main May 7, 2024
20 checks passed
@vincenttran-msft vincenttran-msft deleted the vincenttran/fix_metadata_typehints_fileshare branch May 7, 2024 00:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Storage Storage Service (Queues, Blobs, Files)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants