Skip to content

Commit

Permalink
#43 Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
docktermj committed Apr 29, 2024
1 parent 3bf6b2f commit 3c74f91
Show file tree
Hide file tree
Showing 8 changed files with 17 additions and 15 deletions.
3 changes: 2 additions & 1 deletion examples/misc/add_truthset_data.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,9 @@

from senzing_grpc import SzEngineFlags, SzEngineGrpc, SzError

GRPC_URL = "localhost:8261"

try:
GRPC_URL = "localhost:8261"
grpc_channel = grpc.insecure_channel(GRPC_URL)
sz_engine = SzEngineGrpc(grpc_channel=grpc_channel)
record_sets = [
Expand Down
3 changes: 2 additions & 1 deletion examples/misc/add_truthset_datasources.py
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,9 @@
SzError,
)

GRPC_URL = "localhost:8261"

try:
GRPC_URL = "localhost:8261"
grpc_channel = grpc.insecure_channel(GRPC_URL)
sz_config = SzConfigGrpc(grpc_channel=grpc_channel)
sz_configmgr = SzConfigManagerGrpc(grpc_channel=grpc_channel)
Expand Down
2 changes: 1 addition & 1 deletion examples/szconfig/add_data_source.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@

from senzing_grpc import SzError, szconfig_grpc

GRPC_URL = "localhost:8261"
data_source_code = "NAME_OF_DATASOURCE"
GRPC_URL = "localhost:8261"

try:
grpc_channel = grpc.insecure_channel(GRPC_URL)
Expand Down
4 changes: 2 additions & 2 deletions src/senzing_grpc/szconfig_grpc.py
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ def delete_data_source(
raise new_exception(err) from err

def destroy(self, **kwargs: Any) -> None:
"""Null function"""
"""Null function in the sz-sdk-python-grpc implementation."""

def export_config(self, config_handle: int, **kwargs: Any) -> str:
try:
Expand All @@ -138,7 +138,7 @@ def initialize(
verbose_logging: int = 0,
**kwargs: Any,
) -> None:
"""Null function"""
"""Null function in the sz-sdk-python-grpc implementation."""

def import_config(
self, config_definition: Union[str, Dict[Any, Any]], **kwargs: Any
Expand Down
4 changes: 2 additions & 2 deletions src/senzing_grpc/szconfigmanager_grpc.py
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ def add_config(
raise new_exception(err) from err

def destroy(self, **kwargs: Any) -> None:
"""Null function"""
"""Null function in the sz-sdk-python-grpc implementation."""

def get_config(self, config_id: int, **kwargs: Any) -> str:
try:
Expand Down Expand Up @@ -123,7 +123,7 @@ def initialize(
verbose_logging: int = 0,
**kwargs: Any,
) -> None:
"""Null function"""
"""Null function in the sz-sdk-python-grpc implementation."""

def replace_default_config_id(
self, current_default_config_id: int, new_default_config_id: int, **kwargs: Any
Expand Down
6 changes: 3 additions & 3 deletions src/senzing_grpc/szdiagnostic_grpc.py
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ def check_datastore_performance(self, seconds_to_run: int, **kwargs: Any) -> str
raise new_exception(err) from err

def destroy(self, **kwargs: Any) -> None:
"""Null function"""
"""Null function in the sz-sdk-python-grpc implementation."""

def get_datastore_info(self, **kwargs: Any) -> str:
try:
Expand All @@ -104,10 +104,10 @@ def initialize(
verbose_logging: int = 0,
**kwargs: Any
) -> None:
"""Null function"""
"""Null function in the sz-sdk-python-grpc implementation."""

def purge_repository(self, **kwargs: Any) -> None:
"""Null function"""
"""Null function in the sz-sdk-python-grpc implementation."""

def reinitialize(self, config_id: int, **kwargs: Any) -> None:
try:
Expand Down
6 changes: 3 additions & 3 deletions src/senzing_grpc/szengine_grpc.py
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,7 @@ def delete_record(
raise new_exception(err) from err

def destroy(self, **kwargs: Any) -> None:
"""Null function"""
"""Null function in the sz-sdk-python-grpc implementation."""

def export_csv_entity_report(
self,
Expand Down Expand Up @@ -456,10 +456,10 @@ def initialize(
verbose_logging: int = 0,
**kwargs: Any,
) -> None:
"""Null function"""
"""Null function in the sz-sdk-python-grpc implementation."""

def prime_engine(self, **kwargs: Any) -> None:
"""Null function"""
"""Null function in the sz-sdk-python-grpc implementation."""

def process_redo_record(self, redo_record: str, flags: int, **kwargs: Any) -> str:
try:
Expand Down
4 changes: 2 additions & 2 deletions src/senzing_grpc/szproduct_grpc.py
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ def __exit__(
# -------------------------------------------------------------------------

def destroy(self, **kwargs: Any) -> None:
"""Null function"""
"""Null function in the sz-sdk-python-grpc implementation."""

def initialize(
self,
Expand All @@ -82,7 +82,7 @@ def initialize(
verbose_logging: int = 0,
**kwargs: Any
) -> None:
"""Null function"""
"""Null function in the sz-sdk-python-grpc implementation."""

def get_license(self, **kwargs: Any) -> str:
try:
Expand Down

0 comments on commit 3c74f91

Please sign in to comment.