Skip to content

[text analytics] add --pre suffix to pip install#13523

Merged
iscai-msft merged 3 commits intoAzure:masterfrom
iscai-msft:add_pre_suffix
Sep 3, 2020
Merged

[text analytics] add --pre suffix to pip install#13523
iscai-msft merged 3 commits intoAzure:masterfrom
iscai-msft:add_pre_suffix

Conversation

@iscai-msft
Copy link
Contributor

Should include the --pre specification when installing from pip, since there are both GA and preview versions of this library


```bash
pip install azure-ai-textanalytics
pip install azure-ai-textanalytics --pre
Copy link
Contributor

Choose a reason for hiding this comment

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

we need to update the Note below. Maybe be specific on what version you're getting with/without the --pre flag?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

v good point thankns

Copy link
Contributor Author

Choose a reason for hiding this comment

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

just added a note about this. in the note i explicitly mention 5.0.0 as the latest GA version of the library, since I'm mentioning that the GA version only includes support of v3.0, and this behavior is tied to that version

> Note: This version of the client library supports the v3.0 version of the Text Analytics service
> Note: This version of the client library supports both the v3.0 version, and the preview versions of the v3.1 version of the Text Analytics service. If you do not specify the `--pre` flag when installing the package, you will download version 5.0.0 of the library, which will only
include support of the services v3.0 version. Specifying the `--pre` flag will give you the latest beta release of this library, which includes
support of all preview versions of v3.1, and also continuing support of the service's v3.0 version.
Copy link
Contributor

Choose a reason for hiding this comment

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

this is very nit picky of me, but maybe in the future this could be conveyed better in a table that shows what the command is, the version of the client library you get, and the version of the service supported. As we support more versions, I'm concerned this note will get complicated

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I think that at most there will be two SDK versions that we talk about in the readme though (the latest GA version and the latest beta version), and for each SDK version, we really only need to mention one API version corresponding (i.e., this supports up to version xx). After typign all this out, I do think a table will look clean thoughk, so I'll make it one now

kristapratico
kristapratico previously approved these changes Sep 2, 2020
@iscai-msft iscai-msft merged commit fdf002b into Azure:master Sep 3, 2020
@iscai-msft iscai-msft deleted the add_pre_suffix branch September 10, 2024 15:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants