Merge pull request #222 from danbev/executor-trait-doc-comment

fix: rename executor_options to options in comment
sobelio · Oct 19, 2023 · 8dd78b6 · 8dd78b6
2 parents afef670 + 29b3af3
commit 8dd78b6
Showing 1 changed file with 3 additions and 3 deletions.
diff --git a/crates/llm-chain/src/traits.rs b/crates/llm-chain/src/traits.rs
@@ -55,7 +55,7 @@ pub trait Executor: Sized {
 
     /// Create a new executor with the given options. If you don't need to set any options, you can use the `new` method instead.
     /// # Parameters
-    /// * `executor_options`: The options to set.
+    /// * `options`: The options to set.
     fn new_with_options(options: Options) -> Result<Self, ExecutorCreationError>;
 
     fn new() -> Result<Self, ExecutorCreationError> {
@@ -71,8 +71,8 @@ pub trait Executor: Sized {
     ///
     /// # Parameters
     ///
-    /// * `step`: The step to calculate token usage for.
-    /// * `parameters`: The parameters to plug into the step.
+    /// * `options`: The per-invocation options that affect the token allowance.
+    /// * `prompt`: The prompt passed into step
     ///
     /// # Returns
     ///