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.

Sign up for GitHub

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

Jump to bottom

Minor docs correction for SymbolicPulse library #10161

Merged
merged 2 commits into from
May 25, 2023
Merged

Minor docs correction for SymbolicPulse library #10161

merged 2 commits into from
May 25, 2023

Conversation

TsafrirA
Copy link
Collaborator

Summary

The doc strings for SymbolicPulse's Sawtooth, Triangle, Cos, Sin had an erroneous "&" sign.

@TsafrirA TsafrirA requested review from a team, eggerdj and wshanks as code owners May 25, 2023 11:15
@qiskit-bot
Copy link
Collaborator

One or more of the the following people are requested to review this:

  • @Qiskit/terra-core
  • @nkanazawa1989

jakelishman
jakelishman previously approved these changes May 25, 2023
View reviewed changes
Copy link
Member

@jakelishman jakelishman left a comment

Choose a reason for hiding this comment

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

Cool, thanks!

@jakelishman jakelishman added documentation Something is not clear or an error documentation stable backport potential The bug might be minimal and/or import enough to be port to stable Changelog: None Do not include in changelog labels May 25, 2023
@coveralls
Copy link

coveralls commented May 25, 2023 •
edited
Loading

Pull Request Test Coverage Report for Build 5079628671

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • 24 unchanged lines in 3 files lost coverage.
  • Overall coverage decreased (-0.02%) to 85.915%
Files with Coverage Reduction New Missed Lines %
qiskit/extensions/quantum_initializer/squ.py 2 80.0%
crates/qasm2/src/lex.rs 4 91.14%
crates/qasm2/src/parse.rs 18 95.71%
Totals Coverage Status
Change from base Build 5073178665: -0.02%
Covered Lines: 71263
Relevant Lines: 82946
💛 - Coveralls

@TsafrirA
Copy link
Collaborator Author

@jakelishman
Please hold off merging this PR. I examined the built docs and they are still defective.

@TsafrirA TsafrirA disabled auto-merge May 25, 2023 11:45
@jakelishman
Copy link
Member

It looks fine to me in the docs artifact:

Screenshot 2023-05-25 at 12 52 15

For comparison, here's the same (broken) page in the live docs:

Screenshot 2023-05-25 at 12 53 13

jakelishman
jakelishman reviewed May 25, 2023
View reviewed changes
qiskit/pulse/library/symbolic_pulses.py Outdated
@@ -1655,7 +1655,7 @@ def Triangle(

.. math::

f(x) &= \\text{A}\\left[\\text{sawtooth}\\left(x\\right)right] , 0 <= x < duration
f(x) = \\text{A}\\left[\\text{sawtooth}\\left(x\\right)right] , 0 <= x < duration
Copy link
Member

@jakelishman jakelishman May 25, 2023 •
edited
Loading

Choose a reason for hiding this comment

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

Suggested change
f(x) = \\text{A}\\left[\\text{sawtooth}\\left(x\\right)right] , 0 <= x < duration
f(x) = \\text{A}\\left[\\text{sawtooth}\\left(x\\right)\\right] , 0 <= x < duration

this looks like the major remnant mistake, maybe

Copy link
Collaborator Author

@TsafrirA TsafrirA May 25, 2023 •
edited
Loading

Choose a reason for hiding this comment

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

There were two other missing \ :). Well. At least that's all I could find.
I think everything is in order now.

jakelishman
jakelishman approved these changes May 25, 2023
View reviewed changes
Copy link
Member

@jakelishman jakelishman left a comment

Choose a reason for hiding this comment

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

Ha - just by bad luck it turns out that I was just checking the only one of the changes that didn't have other problems in it!

@jakelishman jakelishman added this pull request to the merge queue May 25, 2023
Merged via the queue into Qiskit:main with commit 5013fe2 May 25, 2023
mergify bot pushed a commit that referenced this pull request May 25, 2023
@TsafrirA @mergify
Minor docs correction for SymbolicPulse library (#10161)
a673177 
* Correct doc string for Sawtooth,Triangle, Cos, Sin

* Added a few missing \

(cherry picked from commit 5013fe2)
@mergify mergify bot mentioned this pull request May 25, 2023
Merged
jakelishman pushed a commit that referenced this pull request May 25, 2023
@mergify @TsafrirA
Minor docs correction for SymbolicPulse library (#10161) (#10165)
87edd8b 
* Correct doc string for Sawtooth,Triangle, Cos, Sin

* Added a few missing \

(cherry picked from commit 5013fe2)

Co-authored-by: TsafrirA <113579969+TsafrirA@users.noreply.github.com>
@TsafrirA TsafrirA deleted the SmallStuff branch June 25, 2023 10:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jakelishman jakelishman jakelishman approved these changes

@eggerdj eggerdj Awaiting requested review from eggerdj eggerdj is a code owner

@wshanks wshanks Awaiting requested review from wshanks wshanks is a code owner

Assignees
No one assigned
Labels
Changelog: None Do not include in changelog documentation Something is not clear or an error documentation stable backport potential The bug might be minimal and/or import enough to be port to stable
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@TsafrirA @qiskit-bot @coveralls @jakelishman