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.

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

docs: update documentation on client / server API #663

Merged
merged 5 commits into from
May 21, 2024

Conversation

jfrery
Copy link
Collaborator

@jfrery jfrery commented May 1, 2024

@jfrery jfrery requested a review from a team as a code owner May 1, 2024 13:20
@cla-bot cla-bot bot added the cla-signed label May 1, 2024
Copy link
Collaborator

@RomanBredehoft RomanBredehoft left a comment

Choose a reason for hiding this comment

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

great update, I suggested a few improvements !

@jfrery jfrery requested a review from RomanBredehoft May 2, 2024 23:04
@jfrery jfrery force-pushed the docs/add_client_server_api_documentation branch from 070b67d to b6d5c85 Compare May 3, 2024 18:58
@jfrery jfrery requested a review from RomanBredehoft May 3, 2024 19:35
client.generate_private_and_evaluation_keys()
# Get the serialized evaluation keys
serialized_evaluation_keys = client.get_serialized_evaluation_keys()
serialized_evaluation_keys = client.generate_private_and_evaluation_keys()
Copy link
Collaborator

Choose a reason for hiding this comment

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

I was thinking more the other way 😅 like keep serialized_evaluation_keys = client.get_serialized_evaluation_keys() but include self.generate_private_and_evaluation_keys() in get_serialized_evaluation_keys

or then have a new method called "generate_keys_and_get_serialized_evaluation_keys` or similar

but that was more of an idea, we could make it an issue and consider it later if you prefer

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Yeah actually it makes more sense the way you describe. Will update.

@jfrery jfrery force-pushed the docs/add_client_server_api_documentation branch from b6d5c85 to 671045c Compare May 7, 2024 16:01
"\n",
"# Get the serialized evaluation keys\n",
"serialized_evaluation_keys = fhemodel_client.get_serialized_evaluation_keys()"
"serialized_evaluation_keys = fhemodel_client.generate_private_and_evaluation_keys()"
Copy link
Collaborator

Choose a reason for hiding this comment

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

this line should still use get_serialized_evaluation_keys

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Good catch. updated.

Copy link
Collaborator

@RomanBredehoft RomanBredehoft left a comment

Choose a reason for hiding this comment

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

there's a last change to fix

@jfrery jfrery force-pushed the docs/add_client_server_api_documentation branch from 9fbc831 to c004669 Compare May 21, 2024 14:02
Copy link
Collaborator

@RomanBredehoft RomanBredehoft left a comment

Choose a reason for hiding this comment

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

thanks a lot !

Copy link

Coverage passed ✅

Coverage details

---------- coverage: platform linux, python 3.8.18-final-0 -----------
Name    Stmts   Miss  Cover   Missing
-------------------------------------
TOTAL    7585      0   100%

59 files skipped due to complete coverage.

@jfrery jfrery merged commit f864407 into main May 21, 2024
13 checks passed
@jfrery jfrery deleted the docs/add_client_server_api_documentation branch May 21, 2024 15:46
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.

None yet

2 participants