chore: formatting, cleanup

Author: pfitzseb

src/MultiDocumenter.jl

@@ -28,8 +28,8 @@ end
 """
     abstract type DropdownComponent
 
-The supertype for any component that can be put in a dropdown column and 
-rendered using `MultiDocumenter.render(::YourComponent, thispagepath, dir, prettyurls)`.  
+The supertype for any component that can be put in a dropdown column and
+rendered using `MultiDocumenter.render(::YourComponent, thispagepath, dir, prettyurls)`.
 
 All `DropdownComponent`s go in [`Column`](@ref)s, which go in [`MegaDropdownNav`](@ref).
 
@@ -128,7 +128,7 @@ function walk_outputs(f, root, docs::Vector, dirs::Vector{String})
             break
         end
     end
-    return
+    return nothing
 end
 
 include("renderers.jl")
@@ -342,7 +342,7 @@ function maybe_clone(docs::Vector)
             end
         end
     end
-    return
+    return nothing
 end
 
 function make_output_structure(
@@ -553,7 +553,7 @@ function inject_styles_and_global_navigation(
         end
     end
 
-    return
+    return nothing
 end
 
 end

src/canonical.jl

@@ -6,9 +6,9 @@ function fix_canonical_url!(
         root_dir::AbstractString,
     )
     # If the user didn't set `canonical`, then we don't need to do anything
-    isnothing(canonical) && return
+    isnothing(canonical) && return nothing
     # The user can also disable the canonical URL fixing on a per-package basis
-    doc.fix_canonical_url || return
+    doc.fix_canonical_url || return nothing
     # Determine the canonical URL and fix them in the HTML files
     documenter_directory_root = joinpath(root_dir, doc.path)
     try
@@ -21,5 +21,5 @@ function fix_canonical_url!(
             (e, catch_backtrace())
     end
 
-    return
+    return nothing
 end

src/documentertools/canonical_urls.jl

@@ -66,7 +66,7 @@ function update_canonical_links_for_version(
             @error "Multiple canonical tags!" file = fileinfo.relpath
         end
     end
-    return
+    return nothing
 end
 
 is_canonical_element(e) =
@@ -124,7 +124,7 @@ function update_canonical_links(docs_directory::AbstractString; canonical::Abstr
         @debug "Updating canonical URLs for a version" path canonical_full_root
         update_canonical_links_for_version(path; canonical = canonical_full_root)
     end
-    return
+    return nothing
 end
 
 function canonical_directory_from_redirect_index_html(docs_directory::AbstractString)
@@ -241,7 +241,8 @@ function extract_versions_list(versions_js::AbstractString)
             ArgumentError(
                 """
                 Could not find DOC_VERSIONS in $(versions_js):
-                $(versions_js_content)"""
+                $(versions_js_content)
+                """
             )
         )
     end
@@ -252,7 +253,8 @@ function extract_versions_list(versions_js::AbstractString)
             ArgumentError(
                 """
                 DOC_VERSIONS empty in $(versions_js):
-                $(versions_js_content)"""
+                $(versions_js_content)
+                """
             )
         )
     end

src/search/flexsearch.jl

@@ -1,7 +1,11 @@
 module FlexSearch
-import Gumbo, JSON, AbstractTrees
+
+using Gumbo: Gumbo
+using JSON: JSON
+using AbstractTrees: AbstractTrees
 using NodeJS_22_jll: node
-using HypertextLiteral
+using HypertextLiteral: @htl
+
 import ..walk_outputs
 
 const ID = Ref(0)
@@ -62,7 +66,7 @@ function add_fragment(doc, el)
             current.content = string(current.content, ' ', Gumbo.text(e))
         end
     end
-    return
+    return nothing
 end
 
 function add_to_index!(index, ref, file)
@@ -84,7 +88,7 @@ function add_to_index!(index, ref, file)
         end
     end
     push!(index.documents, doc)
-    return
+    return nothing
 end
 
 function generate_index(root, docs, config, rootpath)
@@ -104,12 +108,12 @@ function inject_script!(custom_scripts, rootpath)
         custom_scripts,
         Docs.HTML("window.MULTIDOCUMENTER_ROOT_PATH = '$(rootpath)'"),
     )
-    return
+    return nothing
 end
 
 function inject_styles!(custom_styles)
     pushfirst!(custom_styles, joinpath("assets", "default", "flexsearch.css"))
-    return
+    return nothing
 end
 
 function render()
@@ -147,7 +151,7 @@ function to_json_index(index::SearchIndex, file)
         end
         JSON.end_array(writer)
     end
-    return
+    return nothing
 end
 
 function build_search_index(root, docs, config, rootpath)
@@ -159,6 +163,6 @@ function build_search_index(root, docs, config, rootpath)
     cd(root) do
         run(`$(node()) $(joinpath(@__DIR__, "..", "..", "flexsearch", file))`)
     end
-    return
+    return nothing
 end
 end

src/search/pagefind.jl

@@ -9,12 +9,12 @@ function inject_script!(custom_scripts, rootpath)
         custom_scripts,
         Docs.HTML("window.MULTIDOCUMENTER_ROOT_PATH = '$(rootpath)'"),
     )
-    return
+    return nothing
 end
 
 function inject_styles!(custom_styles)
     pushfirst!(custom_styles, joinpath("assets", "default", "pagefind.css"))
-    return
+    return nothing
 end
 
 function render()
@@ -39,7 +39,7 @@ function build_search_index(root, docs, config, rootpath)
     pattern = "*/{$(join(config.index_versions, ","))}/**/*.{html}"
 
     run(`$(npx) pagefind --site $(root) --glob $(pattern) --root-selector article`)
-    return
+    return nothing
 end
 
 end

src/search/stork.jl

@@ -61,18 +61,18 @@ function add_to_index!(files, ref, path)
     end
 
     push!(files, Dict("path" => path, "url" => ref, "title" => title))
-    return
+    return nothing
 end
 
 function inject_script!(custom_scripts, _)
     pushfirst!(custom_scripts, joinpath("assets", "default", "stork.js"))
     pushfirst!(custom_scripts, joinpath("assets", "default", "stork_integration.js"))
-    return
+    return nothing
 end
 
 function inject_styles!(custom_styles)
     pushfirst!(custom_styles, joinpath("assets", "default", "stork.css"))
-    return
+    return nothing
 end
 
 function render()

src/sitemap.jl

@@ -22,7 +22,7 @@ function Base.showerror(io::IO, e::SitemapTooLargeError)
     println(io, " limit is $(e.limit), but sitemap has $(e.value)")
     print(io, SITEMAP_LIMIT_MSG)
 
-    return
+    return nothing
 end
 function check_sitemap_size_limit(msg::AbstractString, value::Integer, limit::Integer)
     if value > limit
@@ -32,7 +32,7 @@ function check_sitemap_size_limit(msg::AbstractString, value::Integer, limit::In
         @warn "Sitemap too large: $(msg) (> 80% soft limit)\n$(SITEMAP_LIMIT_MSG)"
     end
 
-    return
+    return nothing
 end
 
 function make_sitemap(;
@@ -44,13 +44,13 @@ function make_sitemap(;
     sitemap_urls = find_sitemap_urls(; docs_root_directory, sitemap_root)
     if length(sitemap_urls) == 0
         @error "No sitemap URLs found"
-        return
+        return nothing
     end
     sitemap_bytes = make_sitemap_bytes(sitemap_urls)
     # Write the actual sitemap.xml file into the output directory
     write(joinpath(docs_root_directory, sitemap_filename), sitemap_bytes)
 
-    return
+    return nothing
 end
 
 function make_sitemap_bytes(sitemap_urls)::Vector{UInt8}
@@ -96,13 +96,13 @@ function find_sitemap_urls(;
             if DocumenterTools.get_meta_redirect_url(html) === nothing
                 @warn "Canonical URL missing: $(fileinfo.relpath)"
             end
-            return
+            return nothing
         end
         # Check that the canonincal URL is correct.
         # First, we check that the root part is actually what we expect it to be.
         if !startswith(canonical_href, sitemap_root)
             @warn "Invalid canonical URL, excluded from sitemap." canonical_href fileinfo.fullpath
-            return
+            return nothing
         end
         # Let's make sure we're not adding duplicates, but first we must normalize the URL
         canonical_href = normalize_canonical_url(canonical_href)