Add comment for function

tiif · tiif · commit 750c959815d0 · 2024-08-31T14:41:00.000+08:00
diff --git a/src/shims/unix/fd.rs b/src/shims/unix/fd.rs
@@ -627,6 +627,8 @@ pub trait EvalContextExt<'tcx>: crate::MiriInterpCxExt<'tcx> {
         Ok(())
     }
 
+    /// This function write bytes to the user supplied buffer and write the total number of bytes
+    /// written to the dest place. (TODO: fix phrasing later, this function might change)
     fn read_byte_helper(
         &mut self,
         buf: Pointer,

Original file line number	Diff line number	Diff line change
`@@ -627,6 +627,8 @@ pub trait EvalContextExt<'tcx>: crate::MiriInterpCxExt<'tcx> {`
`627`	`627`	`Ok(())`
`628`	`628`	`}`
`629`	`629`
	`630`	`+ /// This function write bytes to the user supplied buffer and write the total number of bytes`
	`631`	`+ /// written to the dest place. (TODO: fix phrasing later, this function might change)`
`630`	`632`	`fn read_byte_helper(`
`631`	`633`	`&mut self,`
`632`	`634`	`buf: Pointer,`