whitespace

Author: fonsp

frontend/editor.js

@@ -42,7 +42,7 @@ const from_attribute = (element, name) => {
     }
 }
 
-const preamble_html_comes_from_url_params = url_params.has("preamble_url")
+const preamble_html_comes_from_url_params = url_params.has("preamble_html")
 
 /**
  *

src/analysis/is_just_text.jl

@@ -5,9 +5,13 @@ const md_and_friends = [
 	:getindex,
 ]
 
-"""Does the cell only contain md"..." and html"..."?
+"""
+Does the cell only contain md"..." and html"..."?
 
-This is used to run these cells first."""
+This means that these cells can run:
+- in "Safe Preview" mode
+- server-side (while waiting for the notebook process to start)
+"""
 function is_just_text(topology::NotebookTopology, cell::Cell)::Bool
 	# https://github.com/fonsp/Pluto.jl/issues/209
         node = topology.nodes[cell]

src/evaluation/WorkspaceManager.jl

@@ -196,7 +196,7 @@ function precompile_nbpkg((session, notebook)::SN; io=stdout)::Bool
         print(io, "Waiting for notebook process to start... ")
     end
     workspace = fetch(workspace_task)
-    not_ready_yet && println(io, "✅")
+    not_ready_yet && println(io, "Done. Starting precompilation...")
     Malt.isrunning(workspace.worker) || return false
 
     io_writes_channel = Malt.worker_channel(workspace.worker, :(__precomp_io_writes_channel = Channel(10)))

src/notebook/Notebook.jl

@@ -32,10 +32,14 @@ Base.@kwdef mutable struct Notebook
     "Cells are ordered in a `Notebook`, and this order can be changed by the user. Cells will always have a constant UUID."
     cells_dict::Dict{UUID,Cell}
     cell_order::Vector{UUID}
+    # cells::Vector{Cell} – you can also use the `.cells` property to get all cells as a vector. This is defined later using a `Base.getproperty` method.
 
     path::String
     notebook_id::UUID=uuid1()
+    # the reactivity information of this notebook
     topology::NotebookTopology
+    
+    # caches used to speed up some operations
     _cached_topological_order::TopologicalOrder
     _cached_cell_dependencies::Dict{UUID,Dict{String,Any}}=Dict{UUID,Dict{String,Any}}()
     _cached_cell_dependencies_source::Union{Nothing,NotebookTopology}=nothing
@@ -50,8 +54,9 @@ Base.@kwdef mutable struct Notebook
     # per notebook compiler options
     # nothing means to use global session compiler options
     compiler_options::Union{Nothing,Configuration.CompilerOptions}=nothing
-    nbpkg_ctx::Union{Nothing,PkgContext}=nothing
-    # nbpkg_ctx::Union{Nothing,PkgContext}=PkgCompat.create_empty_ctx()
+    
+    # package environment management
+    nbpkg_ctx::Union{Nothing,PkgContext}=nothing # nothing means that the notebook is not (yet) using Pluto's automatic package manager.
     nbpkg_ctx_instantiated::Bool=false
     nbpkg_restart_recommended_msg::Union{Nothing,String}=nothing
     nbpkg_restart_required_msg::Union{Nothing,String}=nothing

src/packages/IOListener.jl

@@ -13,7 +13,9 @@ Base.@kwdef struct IOListener
 end
 
 function trigger(listener::IOListener)
+    # if there is data...
     if !eof(listener.buffer) && isreadable(listener.buffer)
+        # ...process it and...
         newdata = readavailable(listener.buffer)
         isempty(newdata) && return
         s = String(newdata)
@@ -23,6 +25,7 @@ function trigger(listener::IOListener)
         )
         new_contents = ANSIEmulation.build_str(listener.ansi_state)
 
+        # ...trigger the callback.
         listener.callback(new_contents)
     end
 end
@@ -50,12 +53,14 @@ function stoplistening(listener::IOListener)
     end
 end
 
+# replace all pkg loading spinner states by the same character. the pluto frontend will make that character spin using CSS magic.
 freeze_loading_spinners(s::AbstractString) = replace(s, '◑' => '◐', '◒' => '◐', '◓' => '◐')
 
-phasemessage(iolistener, phase::String) = phasemessage(iolistener.buffer, phase)
+"write a text with bold formatting"
 function phasemessage(io::IO, phase::String)
     ioc = IOContext(io, :color=>true)
     printstyled(ioc, "\n$phase...\n"; bold=true)
     printstyled(ioc, "===\n"; color=:light_black)
 end
+phasemessage(iolistener, phase::String) = phasemessage(iolistener.buffer, phase)