Class docs #801
Open
Class docs #801
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…on-braket-sdk-python into feature/gate_docstrings
Co-authored-by: Ryan Shaffer <3620100+rmshaffer@users.noreply.github.com>
This reverts commit 759f745.
Codecov ReportAttention:
Additional details and impacted files@@ Coverage Diff @@
## feature/gate_docstrings #801 +/- ##
===========================================================
- Coverage 100.00% 99.98% -0.02%
===========================================================
Files 129 129
Lines 8372 8406 +34
Branches 1865 1901 +36
===========================================================
+ Hits 8372 8405 +33
- Partials 0 1 +1 ☔ View full report in Codecov by Sentry. |
ajberdy
commented
Nov 15, 2023
| @@ -49,13 +49,25 @@ | |||
| """ | |||
| To add a new gate: | |||
| 1. Implement the class and extend `Gate` | |||
| 2. Add a method with the `@circuit.subroutine(register=True)` decorator. Method name | |||
| 2. Add a method with the `@circuit.subroutine(register=True) | |||
| @_prepend_docstring(__doc__)` decorator. Method name | |||
There was a problem hiding this comment.
Whoops this was an artifact of "select all", will fix
rmshaffer
reviewed
Nov 15, 2023
| doc_string = source | ||
| if arg_loc := source.find("\n Args:"): | ||
| doc_string = source[:arg_loc] | ||
| func.__doc__ = "\n".join([doc_string, func.__doc__]) |
There was a problem hiding this comment.
Will this allow the docstring to appear correctly in IDEs like VS Code?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Issue #, if available:
Description of changes:
Add class docstring to circuit subroutines
Testing done:
docs inspection
Merge Checklist
Put an
xin the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your pull request.General
Tests
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.