Skip to content
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

#118 Add documentation for get_feature() #119

Merged
merged 1 commit into from
Nov 6, 2024
Merged

#118 Add documentation for get_feature() #119

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
12 changes: 11 additions & 1 deletion src/senzing_abstract/szdiagnostic_abstract.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,17 @@ def get_datastore_info(self, **kwargs: Any) -> str:
# NOTE This is included but not to be documented
@abstractmethod
def get_feature(self, feature_id: int, **kwargs: Any) -> str:
"""TODO: Document get_feature()"""
"""
**Warning:**
The `get_feature` method is an experimental method that returns diagnostic information of a feature.
Not recommended for use.

Args:
feature_id (int): The identifier of the feature to describe.

Returns:
str: A string containing a JSON document
"""

@abstractmethod
def purge_repository(self, **kwargs: Any) -> None:
Expand Down
Loading