logging and packages

Author: fonsp

big list of undocumented features.md

@@ -19,31 +19,10 @@
 
 ## 2. Package Management (Built-in Pkg)
 
-- **Built-in Pkg management** — Each notebook has its own isolated `Project.toml` / `Manifest.toml` managed by Pluto. (#844)
-- **Automatic package installation** — When you add `using Foo`, Pluto automatically installs the package if missing. (#844)
-- **Per-notebook environments** — Each notebook's package environment is completely isolated from other notebooks and the global environment. (#341, #844)
-- **Pkg popup / bubble UI** — A visual popup shows the status of package operations next to the cell importing a package. (#844)
-- **Pkg terminal output in notebook** — Output from Pkg operations (install, resolve, update) is displayed inside the notebook UI. (#1210, #2498, #2500, #2507)
-- **Fancy Pkg terminal with spinners** — Pkg terminal shows animated spinners and progress bars (TTY mode). (#2500, #2787)
-- **Show Pkg logs in Process Status tab** — Pkg operation logs are visible in the dedicated Process Status panel. (#2498)
-- **Pkg install progress in Binder status** — Binder launch shows step-by-step Pkg install progress. (#2523)
-- **Button to view Pkg terminal in larger window** — A button pops out the Pkg terminal into a fullscreen view. (#3397)
-- **Prevent unnecessary registry updates** — Pluto avoids redundant Pkg registry updates during a session. (#2075)
-- **Auto-fix corrupted manifests** — When a notebook's manifest is broken, Pluto tries strategies to automatically fix it. (#2294, #2298)
-- **Pkg.instantiate before resolve** — Pluto calls `Pkg.instantiate()` before `Pkg.resolve()` when opening notebooks. (#2420, #2504, #2505)
-- **Use `PRESERVE_ALL_INSTALLED` when adding packages** — Pluto prefers already-installed package versions to avoid redundant downloads. (#2902)
 - **Guided Project.toml editor** — A UI for editing the notebook's `Project.toml` with compat entries. (#3218)
-- **Pkg.precompile in notebook process** — Precompilation runs inside the notebook process for better cache reuse. (#2499, #3367, #3377, #3381)
-- **Estimate package install/load time** — The UI shows an estimate of how long packages will take to install and load. (#2265, #2267, #2672)
-- **Inline widget explaining Pkg.activate behavior** — An in-notebook widget explains what `Pkg.activate` does in the notebook context. (#1293)
-- **Capture IO from `Pkg.rm`** — Logs from removing packages are captured and shown in the terminal UI. (#2924)
-- **Capture IO from resolve** — Logs from `Pkg.resolve` are captured and shown. (#3351)
-- **RegistryInstances.jl** — Uses public Pkg API via RegistryInstances.jl instead of internal Pkg internals. (#2289)
-- **Notebook scratch space for environments** — The notebook's hidden `Project.toml`/`Manifest.toml` is stored in a persistent Scratch.jl location (not a temp dir). (#3145)
-- **Package URL in Pkg popup** — Clicking on a package name in the Pkg popup opens its GitHub/docs page. (#3052)
-- **More embedded Pkg API** — `activate_notebook_environment(fun, path)` and related functions exposed for downstream tools. (#2868)
+- **Auto-fix corrupted manifests** — When a notebook's manifest is broken, Pluto tries strategies to automatically fix it. (#2294, #2298)
 - **GracefulPkg.jl integration** — Uses GracefulPkg.jl for safer, more user-friendly Pkg error handling. (#3185)
-- **TestEnv.activate() support** — Works correctly with TestEnv.jl for testing packages. (#3157)
+- **Show Pkg logs in Process Status tab** — Pkg operation logs are visible in the dedicated Process Status panel. (#2498)
 
 ---
 

src/assets/img/progress log demo.gif

@@ -6,11 +6,11 @@ layout: "md.jlmd"
 order: 21
 ---
 
-# 🧾 Logging in Pluto.jl
+# Logging and `stdout`
+
+To help with debugging your code, Pluto supports showing messages printed with the [standard library Logging module](https://docs.julialang.org/en/v1/stdlib/Logging/). This can be done using the `@info`, `@warn` and `@error` macro. 
 
-Pluto supports showing messages printed with the [standard library Logging module](https://docs.julialang.org/en/v1/stdlib/Logging/). This can be done using the `@info`, `@warn` and `@error` macro.
 
-![image](https://user-images.githubusercontent.com/9824244/166148765-d639b659-4e90-4f54-8697-856f24ad4fbc.png)
 
 <!--
 ### Disabling logs for a notebook
@@ -31,7 +31,7 @@ If a package logs warnings or info messages that you want to hide (especially in
 
 Pluto supports an integration with the [ProgressLogging.jl](https://github.com/JuliaLogging/ProgressLogging.jl) package which can be used to display a progress bar in the log message area:
 
-![logs-demo-1](https://user-images.githubusercontent.com/9824244/166149390-f9fce3a4-3b48-4d77-8b06-546401c0103b.gif)
+<img alt="Screen recording of a Progress log going from 0% to 100%." src="$(root_url)/assets/img/progress log demo.gif" width="826" height="572" style="max-width: 400px;">
 
 ## Writing to standard output
 

src/en/docs/logging.jlmd

@@ -50,11 +50,13 @@ You can search for and install any available updates by clicking on the <img src
 ## Long waiting times
 Julia needs to download and precompile packages before you can use them. When using many packages, this can take a **couple of minutes**. Before installing a new package, Pluto can give an estimate of how long it will take to install:
 
+> The estimates are available for popular packages, based on our own [measurements](https://github.com/fonsp/package-loading-times).
+
 <img width="541" alt="Screenshot of code that imports the DataFrames package. Pluto says that the package will be installed when you run the cell, and it gives an estimate of 53 second for the time it will take to install." src="https://github.com/fonsp/Pluto.jl/assets/6933510/942dbfd9-9e25-452e-beb6-2e759be3becf">
 
 {#pre-installed-versions}
 ### Pre-installed versions are preferred
-When adding a package to your notebook, Pluto will ask Pkg to install a version that was previously downloaded on your computer. This was added in May 2024, on older versions, Pkg would always try to install the newest versions.
+When adding a package to your notebook, Pluto will ask Pkg to install a version that was previously downloaded on your computer (with `PRESERVE_ALL_INSTALLED`). This was added in May 2024, on older versions, Pkg would always try to install the newest versions.
 
 This should make it much faster to open a notebook and import some packages that you already used recently. If you need the latest versions, then you have to use the **Update** button after adding the packages.
 
@@ -73,7 +75,7 @@ In Julia 1.6, you can clean up package files that have not been used in a while
 {#based-on-pkg}
 ### Based on Pkg
 
-Pluto's package management is a wrapper around [Pkg.jl](https://pkgdocs.julialang.org/v1/), Julia's built-in package manager. Packages are installed from the [General registry](https://github.com/JuliaRegistries/General). 
+Pluto's package management is a wrapper around [Pkg.jl](https://pkgdocs.julialang.org/v1/) (Julia's built-in package manager) and [RegistryInstances.jl](https://github.com/GunnarFarneback/RegistryInstances.jl). Packages are installed from the [General registry](https://github.com/JuliaRegistries/General). 
 
 > 🙋 You can discover all available packages on [juliahub.com](https://juliahub.com/ui/Home).