some comments

lambdaclass · Feb 13, 2024 · 743702d · 743702d
1 parent 53e13ae
commit 743702d
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 2 deletions.
diff --git a/crates/concrete_codegen_mlir/src/codegen.rs b/crates/concrete_codegen_mlir/src/codegen.rs
@@ -15,6 +15,7 @@ use melior::{
     Context as MeliorContext,
 };
 
+/// Global codegen context
 #[derive(Debug, Clone, Copy)]
 pub(crate) struct CodegenCtx<'a> {
     pub mlir_context: &'a MeliorContext,
@@ -23,6 +24,7 @@ pub(crate) struct CodegenCtx<'a> {
     pub program: &'a ProgramBody,
 }
 
+/// Codegen context for a module
 #[derive(Debug, Clone, Copy)]
 struct ModuleCodegenCtx<'a> {
     pub ctx: CodegenCtx<'a>,
@@ -59,7 +61,7 @@ impl<'a> ModuleCodegenCtx<'a> {
     }
 }
 
-pub fn compile_program(ctx: CodegenCtx) -> Result<(), Box<dyn Error>> {
+pub(crate) fn compile_program(ctx: CodegenCtx) -> Result<(), Box<dyn Error>> {
     for module_id in &ctx.program.top_level_modules {
         let ctx = ModuleCodegenCtx {
             ctx,

diff --git a/crates/concrete_codegen_mlir/src/lib.rs b/crates/concrete_codegen_mlir/src/lib.rs
@@ -40,7 +40,7 @@ pub mod linker;
 mod module;
 mod pass_manager;
 
-/// Returns the object file path.
+/// Compiles the given program and returns the object file path.
 pub fn compile(session: &Session, program: &ProgramBody) -> Result<PathBuf, Box<dyn Error>> {
     let context = Context::new();
     let compile_codegen_time = Instant::now();