[CQT-196] Document all public methods

[elenbaasc]

No description provided.

[rares1609]

I have gone through the files (besides the tests) and pinpointed some public methods which do not have docstrings. I am not 100% certain whether all comments are pertinent as some undocumented public methods are part of private classes (e.g. the _ScheduleCreator), for which maybe you did not write docstrings on purpose.

Another general comment I would have, is that I noticed I noticed that the public methods in qubit_remapper.py also do not have docstrings, both the methods of _QubitRemapper, as well as get_remapped_ir and remap_ir. What is a bit weird is that, looking on the branch locally on my vscode I can see the file, but I can not see it here on the issue in opensquirrel/passes/mapper/... .

[rares1609]

I think now almost all public methods are accounted for! Indeed, it does make sense why abstract methods or private class methods don't require docstrings.

There are only two public methods left (that I notice), that do not have docstrings. Namely: get_remapped_ir and remap_ir from qubit_remapper.py. I am still mentioning them as they are not part of the _QubitRemapper private class, and so maybe these two should also have docstrings? If not, its ready to be merged 👍 .

[rares1609]

All looks good! All public methods have docstrings now, so its ready to be merged 👍