amazon-braket-sdk-python icon indicating copy to clipboard operation
amazon-braket-sdk-python copied to clipboard

Class docs

Open ajberdy opened this issue 2 years ago • 1 comments

Issue #, if available:

Description of changes:

Add class docstring to circuit subroutines

Testing done:

docs inspection

Merge Checklist

Put an x in 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

  • [x] I have read the CONTRIBUTING doc
  • [x] I used the commit message format described in CONTRIBUTING
  • [x] I have updated any necessary documentation, including READMEs and API docs (if appropriate)

Tests

  • [x] I have added tests that prove my fix is effective or that my feature works (if appropriate)
  • [x] I have checked that my tests are not configured for a specific region or account (if appropriate)

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

ajberdy avatar Nov 15 '23 00:11 ajberdy

Codecov Report

:x: Patch coverage is 97.87234% with 1 line in your changes missing coverage. Please review. :white_check_mark: Project coverage is 99.98%. Comparing base (10f4995) to head (1539c8f). :warning: Report is 423 commits behind head on main.

Files with missing lines Patch % Lines
src/braket/circuits/gates.py 97.87% 0 Missing and 1 partial :warning:
Additional details and impacted files
@@             Coverage Diff             @@
##              main     #801      +/-   ##
===========================================
- Coverage   100.00%   99.98%   -0.02%     
===========================================
  Files          129      129              
  Lines         8360     8406      +46     
  Branches      1862     1901      +39     
===========================================
+ Hits          8360     8405      +45     
- Partials         0        1       +1     

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

:rocket: New features to boost your workflow:
  • :snowflake: Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

codecov[bot] avatar Nov 15 '23 00:11 codecov[bot]

Took a different route for solving the issue

speller26 avatar Jul 24 '25 17:07 speller26