add inline explanation of options

denoland · Jun 21, 2024 · db6d62f · db6d62f
1 parent ca58a17
commit db6d62f
Showing 1 changed file with 4 additions and 4 deletions.
diff --git a/dotenv/mod.ts b/dotenv/mod.ts
@@ -243,10 +243,10 @@ export function loadSync(
  * import { load } from "@std/dotenv";
  *
  * const conf = await load({
- *   envPath: "./.env_prod",
- *   examplePath: "./.env_required",
- *   export: true,
- *   allowEmptyValues: true,
+ *   envPath: "./.env_prod", // Uses .env_prod instead of .env
+ *   examplePath: "./.env_required", // Uses .env_required instead of .env.example
+ *   export: true, // Exports all variables to the environment
+ *   allowEmptyValues: true, // Allows empty values for specified env variables
  * });
  * ```
  *