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

Correcting run-on sentences in API-doc #2589

Merged
merged 9 commits into from
Dec 19, 2024

Conversation

Shivansh20128
Copy link
Contributor

@Shivansh20128 Shivansh20128 commented Nov 30, 2024

Description

This PR corrects the run-on sentences in the API Docs inside the kwargs and scale factors. It #Resolves #2422.
I have some blank lines before the bullet points and corrected indentations. The doc build looks good now.

This is how it looked earlier.
image

And this is how it looks now:
image


License

  • I license this contribution under the terms of the GNU GPL, version 3 and grant Unitary Fund the right to provide additional permissions as described in section 7 of the GNU GPL, version 3.

Before opening the PR, please ensure you have completed the following where appropriate.

Copy link

codecov bot commented Nov 30, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.73%. Comparing base (7648648) to head (1ae2fc7).
Report is 7 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #2589   +/-   ##
=======================================
  Coverage   98.73%   98.73%           
=======================================
  Files          92       92           
  Lines        4174     4183    +9     
=======================================
+ Hits         4121     4130    +9     
  Misses         53       53           

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

@cosenal
Copy link
Contributor

cosenal commented Dec 3, 2024

@Shivansh20128 notice that the docs-build is failing with this change. You can test it locally with make docs

@Shivansh20128
Copy link
Contributor Author

I have added the spaces and blank lines wherever required. The docs should look fine now. Let me know if anything else is required here.
Thanks

@natestemen
Copy link
Member

Thanks for the PR! I haven't had a thorough look yet, but two things.

  1. Can you add a PR description, including a link to the issue this is related to?
  2. The documentation build is still failing. If you've already tried to resolve this issue, please document what you found in the PR description as context for a reviewer, or otherwise give it a shot! Feel free to ask questions on the Discord in the Mitiq channel too!

Once these are done, please mark the PR as ready for review and we'll take a detailed look.

@Shivansh20128 Shivansh20128 marked this pull request as ready for review December 15, 2024 07:24
@natestemen natestemen self-requested a review December 18, 2024 01:53
mitiq/cdr/cdr.py Show resolved Hide resolved
mitiq/cdr/cdr.py Show resolved Hide resolved
mitiq/cdr/cdr.py Show resolved Hide resolved
mitiq/cdr/cdr.py Show resolved Hide resolved
mitiq/cdr/cdr.py Show resolved Hide resolved
mitiq/cdr/cdr.py Outdated
@@ -74,22 +74,29 @@ def execute_with_cdr(
scale_noise: scale_noise: Function for scaling the noise of a quantum
Copy link
Collaborator

Choose a reason for hiding this comment

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

scale_noise is repeated twice here.

mitiq/cdr/cdr.py Show resolved Hide resolved
mitiq/cdr/cdr.py Show resolved Hide resolved
mitiq/cdr/clifford_training_data.py Show resolved Hide resolved
mitiq/cdr/clifford_training_data.py Show resolved Hide resolved
@purva-thakre purva-thakre mentioned this pull request Dec 19, 2024
2 tasks
Copy link
Collaborator

@purva-thakre purva-thakre left a comment

Choose a reason for hiding this comment

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

@Shivansh20128 Feel free to ignore all the resolved suggestions made by me. I think what I am suggesting could be tackled in another issue.

mitiq/cdr/cdr.py Outdated Show resolved Hide resolved
mitiq/cdr/cdr.py Outdated Show resolved Hide resolved
@purva-thakre purva-thakre merged commit c4d6a44 into unitaryfund:main Dec 19, 2024
16 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

API-doc has run-on sentences
4 participants