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

[DOCS] Explicitly list **kwargs in QasmModule.unroll function arg / docstring #89

Open
ryanhill1 opened this issue Nov 26, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@ryanhill1
Copy link
Member

The QasmModule.unroll() method currently just specifies **kwargs in it's function argument:

def unroll(self, **kwargs):

On the surface, this seems like a convenient short-hand because these kwargs will be passed directly to the QasmVisitor.__init__ method. However, from the API reference docs page, this isn't clear:

Screenshot 2024-11-26 at 9 29 18 AM

Since the unroll method is public facing, it would be good to document the available kwargs explicitly so that users don't have to dig through the source code to track the kwargs through to initialization of QasmVisitor.

@ryanhill1 ryanhill1 added documentation Improvements or additions to documentation good first issue Good for newcomers labels Nov 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

1 participant