Be more specific about std/log use in modules (#1630)

nushell · Nov 14, 2024 · 37c713b · 37c713b
1 parent 406ffa6
commit 37c713b
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 0 deletions.
diff --git a/book/modules/creating_modules.md b/book/modules/creating_modules.md
@@ -346,6 +346,10 @@ Running this command changes the directory _locally_ in the module, but the chan
 
 ### `export-env` runs only when the `use` call is _evaluated_
 
+::: note
+This scenario is commonly encountered when creating a module that uses `std/log`.
+:::
+
 Attempting to import a module's environment within another environment may not work as expected. Let's create a new module `go.nu` that creates "shortcuts" to common directories. One of these will be the `$env.NU_MODULES_DIR` defined above in `my-utils`.
 
 We might try:

diff --git a/book/standard_library.md b/book/standard_library.md
@@ -146,6 +146,13 @@ nu -n -c "$nu.startup-time"
 
 You will not be able to import the library, any of its submodules, nor use any of its commands, when it is disabled in this way.
 
+## Using `std/log` in Modules
+
+::: warning Important!
+`std/log` exports environment variables. To use the `std/log` module in your own module, please see [this caveat](./modules/creating_modules.md#export-env-runs-only-when-the-use-call-is-evaluated) in the "Creating Modules" Chapter.
+
+:::
+
 ## Optimal Startup
 
 If Nushell's startup time is important to your workflow, review your [startup configuration]([./configuration.md]) in `config.nu`, `env.nu`, and potentially others for inefficient use of the standard library. The following command should identify any problem areas: