docs: more comments added

offline-ai · Aug 14, 2024 · fcff787 · fcff787
1 parent dd95ac7
commit fcff787
Showing 1 changed file with 2 additions and 2 deletions.
diff --git a/lib/file.ai.yaml b/lib/file.ai.yaml
@@ -1,14 +1,14 @@
 ---
 version: 0.1.0
 type: lib
-description: the file loader used in prompt
+description: "the file loader used in prompt. eg, 'user: summary the following file content: @file(document.md)'"
 tag:
   - file
   - loader
   - prompt
   - lib
 input:
-  - result: {required: true} # the file path
+  - result: {required: true} # The file path passed by the prompt
 output:
   type: "string"
 ---