[Unitary-Hack][Sub-ir-braket] Doc in submission/ir/braket.py

[Manvi-Agrawal]

Fixes #984.

Related #957.

bloqade_sub_ir.pdf

[Manvi-Agrawal]

@Roger-luo , I think this might be a good next PR for you to review. This builds up on our discussion from previous PR and I have checked that there are no similar suggestions :-)

[Roger-luo]

While adding a docstring to helper functions is fine, I'm OK with accepting this PR as a bounty since it's already been made and we might not be clear on what methods you should be working on.

However, we will not accept docstrings added to helper functions or private methods in the future. Please work on public APIs in the user space, as I mentioned in #957. This means you should at least take a look at the quick start and tutorial to understand what this package does.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 89.91%. Comparing base (9fdc8cb) to head (3bc413a).
Report is 1 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #978      +/-   ##
==========================================
+ Coverage   89.90%   89.91%   +0.01%     
==========================================
  Files         110      110              
  Lines        8132     8132              
==========================================
+ Hits         7311     7312       +1     
+ Misses        821      820       -1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[Roger-luo]

I think this is good to go, as I commented above, I'll make an exception to count this as 10 docstrings = 40 USD bounty.

[Manvi-Agrawal]

I think this is good to go, as I commented above, I'll make an exception to count this as 10 docstrings = 40 USD bounty.

Thanks a ton @Roger-luo and @weinbe58 for support.