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:
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.
The
QasmModule.unroll()method currently just specifies**kwargsin it's function argument:pyqasm/src/pyqasm/modules/base.py
Line 487 in 5a0c7b3
On the surface, this seems like a convenient short-hand because these
kwargswill be passed directly to theQasmVisitor.__init__method. However, from the API reference docs page, this isn't clear:Since the
unrollmethod 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 ofQasmVisitor.