Skip to content

[textanalytics] update docstrings #25366

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
kristapratico merged 1 commit into from
Jul 22, 2022
Merged

[textanalytics] update docstrings #25366

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
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 36 additions & 4 deletions sdk/textanalytics/azure-ai-textanalytics/azure/ai/textanalytics/_lro.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -215,11 +215,20 @@ def get_continuation_token(self):

class AnalyzeHealthcareEntitiesLROPoller(LROPoller[PollingReturnType]):
def polling_method(self) -> AnalyzeHealthcareEntitiesLROPollingMethod:
"""Return the polling method associated to this poller."""
"""Return the polling method associated to this poller.

:return: AnalyzeHealthcareEntitiesLROPollingMethod
:rtype: AnalyzeHealthcareEntitiesLROPollingMethod
"""
return self._polling_method # type: ignore

@property
def details(self) -> Mapping[str, Any]:
"""Long-running operation metadata.

:return: A mapping of details about the long-running operation.
:rtype: Mapping[str, Any]
"""
return {
"id": self.polling_method().id,
"created_on": self.polling_method().created_on,
Expand Down Expand Up @@ -247,7 +256,14 @@ def from_continuation_token( # type: ignore
continuation_token: str,
**kwargs: Any
) -> "AnalyzeHealthcareEntitiesLROPoller": # type: ignore
"""
"""Internal use only.

:param polling_method: Polling method to use.
:type polling_method: AnalyzeHealthcareEntitiesLROPollingMethod
:param str continuation_token: Opaque token.
:return: AnalyzeHealthcareEntitiesLROPoller
:rtype: AnalyzeHealthcareEntitiesLROPoller

:meta private:
"""
client, initial_response, deserialization_callback = polling_method.from_continuation_token(
Expand Down Expand Up @@ -388,11 +404,20 @@ def get_continuation_token(self):

class AnalyzeActionsLROPoller(LROPoller[PollingReturnType]):
def polling_method(self) -> AnalyzeActionsLROPollingMethod:
"""Return the polling method associated to this poller."""
"""Return the polling method associated to this poller.

:return: AnalyzeActionsLROPollingMethod
:rtype: AnalyzeActionsLROPollingMethod
"""
return self._polling_method # type: ignore

@property
def details(self) -> Mapping[str, Any]:
"""Long-running operation metadata.

:return: A mapping of details about the long-running operation.
:rtype: Mapping[str, Any]
"""
return {
"id": self.polling_method().id,
"created_on": self.polling_method().created_on,
Expand Down Expand Up @@ -428,7 +453,14 @@ def from_continuation_token( # type: ignore
continuation_token: str,
**kwargs: Any
) -> "AnalyzeActionsLROPoller": # type: ignore
"""
"""Internal use only.

:param polling_method: Polling method to use.
:type polling_method: AnalyzeActionsLROPollingMethod
:param str continuation_token: Opaque token.
:return: AnalyzeActionsLROPoller
:rtype: AnalyzeActionsLROPoller

:meta private:
"""
client, initial_response, deserialization_callback = polling_method.from_continuation_token(
Expand Down
2 changes: 0 additions & 2 deletions sdk/textanalytics/azure-ai-textanalytics/azure/ai/textanalytics/_models.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,13 +37,11 @@ def __delitem__(self, key):
self.__dict__[key] = None

def __eq__(self, other):
"""Compare objects by comparing all attributes."""
if isinstance(other, self.__class__):
return self.__dict__ == other.__dict__
return False

def __ne__(self, other):
"""Compare objects by comparing all attributes."""
return not self.__eq__(other)

def __contains__(self, key):
Expand Down
40 changes: 36 additions & 4 deletions sdk/textanalytics/azure-ai-textanalytics/azure/ai/textanalytics/aio/_lro_async.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -185,11 +185,20 @@ def get_continuation_token(self):

class AsyncAnalyzeHealthcareEntitiesLROPoller(AsyncLROPoller[PollingReturnType]):
def polling_method(self) -> AsyncAnalyzeHealthcareEntitiesLROPollingMethod: # type: ignore
"""Return the polling method associated to this poller."""
"""Return the polling method associated to this poller.

:return: AsyncAnalyzeHealthcareEntitiesLROPollingMethod
:rtype: AsyncAnalyzeHealthcareEntitiesLROPollingMethod
"""
return self._polling_method # type: ignore

@property
def details(self) -> Mapping[str, Any]:
"""Long-running operation metadata.

:return: A mapping of details about the long-running operation.
:rtype: Mapping[str, Any]
"""
return {
"id": self.polling_method().id,
"created_on": self.polling_method().created_on,
Expand Down Expand Up @@ -217,7 +226,14 @@ def from_continuation_token( # type: ignore
continuation_token: str,
**kwargs: Any
) -> "AsyncAnalyzeHealthcareEntitiesLROPoller":
"""
"""Internal use only.

:param polling_method: Polling method to use.
:type polling_method: AsyncAnalyzeHealthcareEntitiesLROPollingMethod
:param str continuation_token: Opaque token.
:return: AsyncAnalyzeHealthcareEntitiesLROPoller
:rtype: AsyncAnalyzeHealthcareEntitiesLROPoller

:meta private:
"""
client, initial_response, deserialization_callback = polling_method.from_continuation_token(
Expand Down Expand Up @@ -355,11 +371,20 @@ def get_continuation_token(self):

class AsyncAnalyzeActionsLROPoller(AsyncLROPoller[PollingReturnType]):
def polling_method(self) -> AsyncAnalyzeActionsLROPollingMethod: # type: ignore
"""Return the polling method associated to this poller."""
"""Return the polling method associated to this poller.

:return: AsyncAnalyzeActionsLROPollingMethod
:rtype: AsyncAnalyzeActionsLROPollingMethod
"""
return self._polling_method # type: ignore

@property
def details(self) -> Mapping[str, Any]:
"""Long-running operation metadata.

:return: A mapping of details about the long-running operation.
:rtype: Mapping[str, Any]
"""
return {
"id": self.polling_method().id,
"created_on": self.polling_method().created_on,
Expand Down Expand Up @@ -395,7 +420,14 @@ def from_continuation_token( # type: ignore
continuation_token: str,
**kwargs: Any
) -> "AsyncAnalyzeActionsLROPoller": # type: ignore
"""
"""Internal use only.

:param polling_method: Polling method to use.
:type polling_method: AsyncAnalyzeActionsLROPollingMethod
:param str continuation_token: Opaque token.
:return: AsyncAnalyzeActionsLROPoller
:rtype: AsyncAnalyzeActionsLROPoller

:meta private:
"""
client, initial_response, deserialization_callback = polling_method.from_continuation_token(
Expand Down