Skip to content

Deprecate circuit-library Jupyter magic#9940

Merged
mtreinish merged 3 commits intoQiskit:mainfrom
jakelishman:deprecate-circuit-library-magic
May 12, 2023
Merged

Deprecate circuit-library Jupyter magic#9940
mtreinish merged 3 commits intoQiskit:mainfrom
jakelishman:deprecate-circuit-library-magic

Conversation

@jakelishman
Copy link
Copy Markdown
Member

Summary

This has not been used since the switch away from using jupyter-execute in gh-9346, so is neither maintained nor necessary. Any improvements to styling should be made to the new paths, not to these. These objects were originally intended only for the documentation so we expect user impact to be minimal, and the objects are not maintained anyway.

Details and comments

These are the only direct users of the Pygments lexer that caused us problems that needed a fix in #9938. We planned to deprecate these in #9346 (comment), but we failed to follow up on it at the time.

This has not been used since the switch away from using
`jupyter-execute` in Qiskitgh-9346, so is neither maintained nor necessary.
Any improvements to styling should be made to the new paths, not to
these.  These objects were originally intended only for the
documentation so we expect user impact to be minimal, and the objects
are not maintained anyway.
@jakelishman jakelishman added the Changelog: Deprecated Add a "Deprecated" entry in the GitHub Release changelog. label Apr 11, 2023
@jakelishman jakelishman requested a review from a team as a code owner April 11, 2023 13:34
@qiskit-bot
Copy link
Copy Markdown
Collaborator

Thank you for opening a new pull request.

Before your PR can be merged it will first need to pass continuous integration tests and be reviewed. Sometimes the review process can be slow, so please be patient.

While you're waiting, please feel free to review other open PRs. While only a subset of people are authorized to approve pull requests for merging, everyone is encouraged to review open pull requests. Doing reviews helps reduce the burden on the core team and helps make the project's code better for everyone.

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

  • @Qiskit/terra-core

@mtreinish mtreinish added this to the 0.25.0 milestone Apr 11, 2023
@jakelishman
Copy link
Copy Markdown
Member Author

jakelishman commented Apr 11, 2023

Oh yeah, I forgot about the freeze - I've put the wrong version in all the since fields (fixed in 746dde0).

On another note: I checked Paul's blog (expecting that to be the most likely place the magic might still be used), and it's not there.

@coveralls
Copy link
Copy Markdown

coveralls commented Apr 11, 2023

Pull Request Test Coverage Report for Build 4669473687

  • 0 of 8 (0.0%) changed or added relevant lines in 2 files are covered.
  • 22 unchanged lines in 6 files lost coverage.
  • Overall coverage decreased (-0.01%) to 85.421%

Changes Missing Coverage Covered Lines Changed/Added Lines %
qiskit/tools/jupyter/jupyter_magics.py 0 2 0.0%
qiskit/tools/jupyter/library.py 0 6 0.0%
Files with Coverage Reduction New Missed Lines %
qiskit/tools/jupyter/jupyter_magics.py 1 0%
qiskit/transpiler/passes/utils/check_map.py 1 97.67%
crates/accelerate/src/sabre_swap/mod.rs 3 98.83%
qiskit/transpiler/preset_passmanagers/common.py 4 97.53%
qiskit/tools/jupyter/library.py 5 0%
crates/accelerate/src/vf2_layout.rs 8 86.44%
Totals Coverage Status
Change from base Build 4632030902: -0.01%
Covered Lines: 67791
Relevant Lines: 79361

💛 - Coveralls

@mtreinish mtreinish added this pull request to the merge queue May 12, 2023
Merged via the queue into Qiskit:main with commit 5177db6 May 12, 2023
@jakelishman jakelishman deleted the deprecate-circuit-library-magic branch May 16, 2023 08:21
king-p3nguin pushed a commit to king-p3nguin/qiskit-terra that referenced this pull request May 22, 2023
* Deprecate circuit-library Jupyter magic

This has not been used since the switch away from using
`jupyter-execute` in Qiskitgh-9346, so is neither maintained nor necessary.
Any improvements to styling should be made to the new paths, not to
these.  These objects were originally intended only for the
documentation so we expect user impact to be minimal, and the objects
are not maintained anyway.

* Correct versions for deprecation

* Add missing import
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Changelog: Deprecated Add a "Deprecated" entry in the GitHub Release changelog.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants