diff --git a/opensquirrel/parsing/antlr/squirrel_ast_creator.py b/opensquirrel/parsing/antlr/squirrel_ast_creator.py index 1c193b74..6a85fe9e 100644 --- a/opensquirrel/parsing/antlr/squirrel_ast_creator.py +++ b/opensquirrel/parsing/antlr/squirrel_ast_creator.py @@ -5,6 +5,11 @@ class SquirrelASTCreator(CQasm3Visitor.CQasm3Visitor): + """ + This class creates a SquirrelAST object from an ANTLR parse tree. + It is an instance of the ANTLR grammar visitor. + Therefore, method names are fixed and based on rule names in the Grammar .g4 file. + """ def __init__(self, gates): self.gates = gates self.squirrel_ast = None