Update documentation (#17)

IBM · Sep 4, 2024 · d1dbeaa · d1dbeaa
1 parent c900d02
commit d1dbeaa
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 5 deletions.
diff --git a/docs/api_reference.md b/docs/api_reference.md
@@ -6,8 +6,11 @@ This page documents the PDL members that likely to be used to run PDL programs f
 ::: pdl.pdl_ast
 
 ## Interpreter
-::: pdl.pdl_interpreter
+::: pdl.pdl
+
 <!-- 
+::: pdl.pdl_interpreter
+
 ::: pdl.pdl_interpreter.InterpreterState
     options:
         show_if_no_docstring: true

diff --git a/pdl/pdl.py b/pdl/pdl.py
@@ -40,7 +40,7 @@ def exec_program(
     config: Optional[InterpreterConfig] = None,
     scope: Optional[ScopeType] = None,
     loc: Optional[LocationType] = None,
-):
+) -> Any:
     """Execute a PDL program given as a value of type `pdl.pdl_ast.Program`.
 
     Args:
@@ -65,7 +65,7 @@ def exec_dict(
     config: Optional[InterpreterConfig] = None,
     scope: Optional[ScopeType] = None,
     loc: Optional[LocationType] = None,
-):
+) -> Any:
     """Execute a PDL program given as a dictionary.
 
     Args:
@@ -86,7 +86,7 @@ def exec_str(
     prog: str,
     config: Optional[InterpreterConfig] = None,
     scope: Optional[ScopeType] = None,
-):
+) -> Any:
     """Execute a PDL program given as YAML string.
 
     Args:
@@ -106,7 +106,7 @@ def exec_file(
     prog: str,
     config: Optional[InterpreterConfig] = None,
     scope: Optional[ScopeType] = None,
-):
+) -> Any:
     """Execute a PDL program given as YAML file.
 
     Args: