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

qiskit.transpiler needs function & class examples #3435

Closed
nonhermitian opened this issue Nov 8, 2019 · 3 comments
Closed

qiskit.transpiler needs function & class examples #3435

nonhermitian opened this issue Nov 8, 2019 · 3 comments
Labels
documentation Something is not clear or an error documentation good first issue Good for newcomers

Comments

@nonhermitian
Copy link
Contributor

What is the expected enhancement?

@nonhermitian nonhermitian added the documentation Something is not clear or an error documentation label Nov 8, 2019
@1ucian0 1ucian0 added the good first issue Good for newcomers label Sep 19, 2021
@javabster javabster changed the title qiskit.transpiler needs module level docstrings and function & class examples qiskit.transpiler needs function & class examples Dec 15, 2021
@jakelishman
Copy link
Member

While there's always more documentation that could be written, after #4134 this documentation has rather more content than it did when the issue was created.

If somebody were to extend this, good things to add would be:

  • tweak the introduction to actually talk about qiskit.transpile and include a cross reference to it
  • update the current text which is out-of-date (the part about layout passes, for one)
  • talk about how to create a custom pass manager with the current set-up (Add StagedPassManager class for pass manager with defined stages #6403 notwithstanding)
  • more prominently link to the list of passes qiskit.transpiler.passes

@joeswashington
Copy link

Hey I am looking for a good first issue to work on. Is this still needed? If so can I be assigned to it?

@mtreinish
Copy link
Member

mtreinish commented May 17, 2023

I'm not sure this issue is still relevant in the last couple of releases we've updated and improved the top level transpiler documentation quite a bit since the last comment ~1.5 yrs ago: https://qiskit.org/documentation/apidoc/transpiler.html (see #9087 for the details of those improvements). So I think that I'm going to close this issue as not being relevant anymore.

That being said @joeswashington if you look at the content on that page and see anything that you think needs improvement please feel free to comment here and we can reopen this issue. Or also just open a pull request with any changes you would like to make to the documentation and we can discuss them there too.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Something is not clear or an error documentation good first issue Good for newcomers
Projects
Status: Done
Development

No branches or pull requests

5 participants