Add docstring to squirrel_ast_creator

QuTech-Delft · Dec 4, 2023 · 3382967 · 3382967
1 parent 76b1685
commit 3382967
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/opensquirrel/parsing/antlr/squirrel_ast_creator.py b/opensquirrel/parsing/antlr/squirrel_ast_creator.py
@@ -5,6 +5,12 @@
 
 
 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