-
-
Notifications
You must be signed in to change notification settings - Fork 166
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
Correcting run-on sentences in API-doc #2589
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
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. |
@Shivansh20128 notice that the docs-build is failing with this change. You can test it locally with |
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 for the PR! I haven't had a thorough look yet, but two things.
Once these are done, please mark the PR as ready for review and we'll take a detailed look. |
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 |
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.
scale_noise
is repeated twice 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.
@Shivansh20128 Feel free to ignore all the resolved suggestions made by me. I think what I am suggesting could be tackled in another issue.
Description
This PR corrects the run-on sentences in the API Docs inside the
kwargs
andscale 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.
And this is how it looks now:
License
Before opening the PR, please ensure you have completed the following where appropriate.