doc: dialect module docstring (#194)

Author: Roger-luo

src/kirin/dialects/eltype.py

@@ -1,4 +1,4 @@
-"""this dialect offers a statement `eltype` for other dialects'
+"""This dialect offers a statement `eltype` for other dialects'
 type inference to query/implement the element type of a value.
 For example, the `ilist` dialect implements the `eltype` statement
 on the `ilist.IList` type to return the element type.

src/kirin/dialects/lowering/cf.py

@@ -47,7 +47,7 @@ def new_block_arg_if_inside_loop(frame: Frame, capture: ir.SSAValue):
         )
         body_frame.next_block = next_block
         next_value = body_frame.entry_block.args.append_from(ir.types.Any, "next_value")
-        py.unpack.unpackable(state, node.target, next_value)
+        py.unpack.unpacking(state, node.target, next_value)
         state.exhaust(body_frame)
         next_stmt = body_frame.append_stmt(py.iterable.Next(iter_stmt.iter))
         cond_stmt = body_frame.append_stmt(py.cmp.Is(next_stmt.value, none_stmt.result))

src/kirin/dialects/py/__init__.py

@@ -1,3 +1,11 @@
+"""Python dialects module.
+
+This module contains a set of dialects that represent
+different fractions of the Python language. The dialects
+are designed to be used in a union to represent the
+entire Python language.
+"""
+
 from . import (
     cmp as cmp,
     len as len,

src/kirin/dialects/py/assertion.py

@@ -1,3 +1,16 @@
+"""Assertion dialect for Python.
+
+This module contains the dialect for the Python `assert` statement, including:
+
+- The `Assert` statement class.
+- The lowering pass for the `assert` statement.
+- The concrete implementation of the `assert` statement.
+- The type inference implementation of the `assert` statement.
+- The Julia emitter for the `assert` statement.
+
+This dialect maps `ast.Assert` nodes to the `Assert` statement.
+"""
+
 import ast
 
 from kirin import ir, types, interp, lowering

src/kirin/dialects/py/assign.py

@@ -1,3 +1,14 @@
+"""Assignment dialect for Python.
+
+This module contains the dialect for the Python assignment statement, including:
+
+- Statements: `Alias`, `SetItem`.
+- The lowering pass for the assignments.
+- The concrete implementation of the assignment statements.
+
+This dialects maps Python assignment syntax.
+"""
+
 import ast
 
 from kirin import ir, interp, lowering, exceptions

src/kirin/dialects/py/attr.py

@@ -1,3 +1,14 @@
+"""Attribute access dialect for Python.
+
+This module contains the dialect for the Python attribute access statement, including:
+
+- The `GetAttr` statement class.
+- The lowering pass for the attribute access statement.
+- The concrete implementation of the attribute access statement.
+
+This dialect maps `ast.Attribute` nodes to the `GetAttr` statement.
+"""
+
 import ast
 
 from kirin import ir, interp, lowering, exceptions

src/kirin/dialects/py/binop/__init__.py

@@ -1,3 +1,18 @@
+"""The binop dialect for Python.
+
+This module contains the dialect for binary operation semantics in Python, including:
+
+- The `Add`, `Sub`, `Mult`, `Div`, `FloorDiv`, `Mod`, `Pow`,
+    `LShift`, `RShift`, `BitOr`, `BitXor`, and `BitAnd` statement classes.
+- The lowering pass for binary operations.
+- The concrete implementation of binary operations.
+- The type inference implementation of binary operations.
+- The Julia emitter for binary operations.
+
+This dialect maps `ast.BinOp` nodes to the `Add`, `Sub`, `Mult`, `Div`, `FloorDiv`,
+`Mod`, `Pow`, `LShift`, `RShift`, `BitOr`, `BitXor`, and `BitAnd` statements.
+"""
+
 from . import (
     julia as julia,
     interp as interp,

src/kirin/dialects/py/boolop.py

@@ -1,3 +1,15 @@
+"""Boolean operators for Python dialect.
+
+This module contains the dialect for the Python boolean operators, including:
+
+- The `And` and `Or` statement classes.
+- The lowering pass for the boolean operators.
+- The concrete implementation of the boolean operators.
+- The Julia emitter for the boolean operators.
+
+This dialect maps `ast.BoolOp` nodes to the `And` and `Or` statements.
+"""
+
 import ast
 
 from kirin import ir, interp, lowering

src/kirin/dialects/py/builtin.py

@@ -1,3 +1,15 @@
+"""builtin dialect for python builtins
+
+This dialect provides implementations for builtin functions like abs and sum.
+
+- Statements: `Abs`, `Sum`.
+- The lowering pass for the builtin functions.
+- The concrete implementation of the builtin functions.
+- The type inference implementation of the builtin functions.
+
+This dialect maps `ast.Call` nodes of builtin functions to the `Abs` and `Sum` statements.
+"""
+
 from ast import Call
 
 from kirin import ir, types, interp, lowering

src/kirin/dialects/py/cmp/__init__.py

@@ -1,3 +1,16 @@
+"""The cmp dialect for Python.
+
+This module contains the dialect for comparison semantics in Python, including:
+
+- The `Eq`, `NotEq`, `Lt`, `LtE`, `Gt`, `GtE`, `Is`, and `IsNot` statement classes.
+- The lowering pass for comparison operations.
+- The concrete implementation of comparison operations.
+- The Julia emitter for comparison operations.
+
+This dialect maps `ast.Compare` nodes to the `Eq`, `NotEq`, `Lt`, `LtE`,
+`Gt`, `GtE`, `Is`, and `IsNot` statements.
+"""
+
 from . import julia as julia, interp as interp, lowering as lowering
 from .stmts import *  # noqa: F403
 from ._dialect import dialect as dialect