-
Notifications
You must be signed in to change notification settings - Fork 620
Improve Documentation for PQC and Expectation Layers (GH#238) #895
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
base: master
Are you sure you want to change the base?
Improve Documentation for PQC and Expectation Layers (GH#238) #895
Conversation
Hi @mhucka |
@Aniketsy Thank you for your work. There's one minor format issue I see right off: we're trying to keep to 80 character line lengths (see the |
@mhucka Thanks! I’ve fixed the format error and updated the PR. I’d also love to contribute to other issues, but I understand they are already assigned. Please feel free to point out any issues I could work on I’d be happy to take them on. |
@Aniketsy Thank you for your interest. I did a round of updates on all the issues and unassigned a couple. You don't necessarily have to take these on, but it would be hard to find which ones were unassigned, so I'll just list them here: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This looks good. A couple of trivial requests. These are not about your changes but about the rest of the file, and I thought since you're fixing up the docstrings in this file, these could be done along the way:
- Super trivial: the docstring for the class
Expectation
has an extra empty line on line 229, which by docstring conventions shouldn't be there. Could you remove it? - The docstring for
__init__
lacks documentation for thekwargs
argument. Could you add a description as part of this PR?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Also, make sure to update the branch using the button in the GitHub interface. (If I do it, it may add my name to the PR, which I feel would be unfair.)
Thanks! I’ve applied the changes based on your suggestions. |
This PR enhances the docstrings for the PQC and Expectation layers to comply with TensorFlow documentation standards.
Updates:
Added structured Args, Input shape, and Output shape sections to the class level docstrings.
Updated the call method docstrings with explicit Args and Returns sections, including types and tensor shapes.
Please let me know if this fix needs any improvements . I’m open to feedback and happy to make changes based on suggestions.
Thankyou!