Skip to content

[Cognitive Services - Azure AI Content Safety] Update package print name. #26911

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

Merged
mengaims merged 3 commits into from
Dec 1, 2023
+1 −0
Merged

[Cognitive Services - Azure AI Content Safety] Update package print name. #26911

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8c1c129
Update package print name.
JieZhou000 Dec 1, 2023
4bbd0e3
update.
JieZhou000 Dec 1, 2023
f007d69
update name.
JieZhou000 Dec 1, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions specification/cognitiveservices/ContentSafety/tspconfig.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ options:
package-dir: "azure-ai-contentsafety"
package-version: "1.0.0"
package-name: "{package-dir}"
package-pprint-name: "\"Azure AI Content Safety\""
Copy link
Copy Markdown
Member

@catalinaperalta catalinaperalta Dec 1, 2023

Choose a reason for hiding this comment

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

Why are you including the quotes in the name?

Copy link
Copy Markdown
Contributor Author

@JieZhou000 JieZhou000 Dec 4, 2023

Choose a reason for hiding this comment

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

I searched through other projects in this repository to see how they used package-pprint-name. I noticed that everyone included quotes, so I followed suit and used quotes as well.

Copy link
Copy Markdown
Member

@weshaggard weshaggard Dec 4, 2023

Choose a reason for hiding this comment

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

@catalinaperalta Can you help me understand why we need this extra property? I don't think the escaped quotes should be needed either. Also the version property should be removed as it isn't needed.

Copy link
Copy Markdown
Member

@catalinaperalta catalinaperalta Dec 20, 2023 •
edited
Loading

Choose a reason for hiding this comment

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

The property is used in setup.py for python packages and is used as part of the display name for the package on PyPi. Here is Content Safety's setup.py: https://github.com/Azure/azure-sdk-for-python/blob/20423ff39c28318cd219f520709d9efea360faf6/sdk/contentsafety/azure-ai-contentsafety/setup.py#L16

How it looks on PyPi:
image

and yes the escaped quotes are not necessary.

"@azure-tools/typespec-csharp":
package-dir: "Azure.AI.ContentSafety"
namespace: "{package-dir}"
Expand Down
⚡