Minor update to docstrings

- Revert to old version
- Minor update to docs to come with version increase

Author: JulStraus

NEWS.md

@@ -1,6 +1,6 @@
 # Release notes
 
-## Version 0.5.16 (2025-08-14)
+## Unversioned
 
 ### Enhancement
 
@@ -38,6 +38,7 @@
 * Added more descriptive names for `EnergyModelsHeat` and `EnergyModelsHydrogen` and add a colors for the `HeatLT` and `HeatHT` resources.
 
 ### Adjustment
+
 * Order the colors (by id) in the Resources legend.
 * Move boundaries for countries just above the ocean layer.
 * Fix default placements of the nodes in a uniform circle (when coordinates are not provided).

Project.toml

@@ -1,7 +1,7 @@
 name = "EnergyModelsGUI"
 uuid = "737a7361-d3b7-40e9-b1ac-59bee4c5ea2d"
 authors = ["Jon Vegard Venås <JonVegard.Venas@sintef.no>", "Magnus Askeland <Magnus.Askeland@sintef.no>", "Shweta Tiwari <Shweta.Tiwari@sintef.no>"]
-version = "0.5.16"
+version = "0.5.15"
 
 [deps]
 CSV = "336ed68f-0bac-5ca0-87d4-7b16caf5d00b"

docs/Project.toml

@@ -1,6 +1,7 @@
 [deps]
 CairoMakie = "13f3f980-e62b-5c42-98c6-ff1f3baf88f0"
 Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
+DocumenterInterLinks = "d12716ef-a0f6-4df4-a9f1-a5a34e75c656"
 EnergyModelsBase = "5d7e687e-f956-46f3-9045-6f5a5fd49f50"
 EnergyModelsGUI = "737a7361-d3b7-40e9-b1ac-59bee4c5ea2d"
 EnergyModelsGeography = "3f775d88-a4da-46c4-a2cc-aa9f16db6708"

docs/make.jl

@@ -18,6 +18,10 @@ DocMeta.setdocmeta!(
     EnergyModelsGUI, :DocTestSetup, :(using EnergyModelsGUI); recursive = true,
 )
 
+links = InterLinks(
+    "EnergyModelsBase" => "https://energymodelsx.github.io/EnergyModelsBase.jl/stable/",
+)
+
 makedocs(;
     sitename = "EnergyModelsGUI.jl",
     format = Documenter.HTML(;
@@ -36,7 +40,7 @@ makedocs(;
             "Example"=>"manual/simple-example.md",
             "Release notes"=>"manual/NEWS.md",
         ],
-        "How-to" => Any[
+        "How to" => Any[
             "Save design to file"=>"how-to/save-design.md",
             "Export results"=>"how-to/export-results.md",
             "Customize colors"=>"how-to/customize-colors.md",
@@ -48,6 +52,7 @@ makedocs(;
             "Internals"=>Any["Reference"=>"library/internals/reference.md",],
         ],
     ],
+    plugins=[links],
 )
 
 deploydocs(; repo = "github.com/EnergyModelsX/EnergyModelsGUI.jl.git")

src/setup_GUI.jl

@@ -1,19 +1,21 @@
 """
     GUI(case::Case; kwargs...)
+    GUI(case::Dict; kwargs...)
 
-Initialize the EnergyModelsGUI window and visualize the topology of a system `case` \
+Initialize the `EnergyModelsGUI` window and visualize the topology of a system `case`
 (and optionally visualize its results in a JuMP object model). The input argument can either
-be a `Case` object from the EnergyModelsBase package or a dictionary containing system-related
-data stored as key-value pairs. This dictionary is corresponding to the the old EnergyModelsX
-`case` dictionary.
+be a [`Case`](@extref EnergyModelsBase.Case) instance from the `EnergyModelsBase` package or
+a dictionary containing system-related data stored as key-value pairs. The latter corresponds
+to the old EnergyModelsX `case` dictionary.
 
 # Keyword arguments:
 
 - **`design_path::String=""`** is a file path or identifier related to the design.
 - **`id_to_color_map::Dict=Dict()`** is a dict that maps `Resource`s `id` to colors.
 - **`id_to_icon_map::Dict=Dict()`** is a dict that maps `Node/Area` `id` to .png files for icons.
 - **`model::Union{JuMP.Model, String}`** is the solved JuMP model with results for the `case`,
-  but can also be the path (String) to the directory containing the JuMP results written as CSV-files.
+  but can also be the path (`String`) to the directory containing the JuMP results written as
+  CSV-files.
 - **`hide_topo_ax_decorations::Bool=true`** is a visibility toggle of ticks, ticklabels and
   grids for the topology axis.
 - **`expand_all::Bool=false`** is the default option for toggling visibility of all nodes
@@ -37,9 +39,9 @@ data stored as key-value pairs. This dictionary is corresponding to the the old
 - **`colormap::Vector=Makie.wong_colors()`** is the colormap used for plotting results.
 - **`tol::Float64=1e-12`** the tolerance for numbers close to machine epsilon precision.
 
-!!! warning "Reading model results from csv-files"
-    Reading model results from a directory (i.e., `model::String`) do not support more than
-    three indices for variables (i.e., when results are read from .csv-files).
+!!! warning "Reading model results from CSV-files"
+    Reading model results from a directory (*i.e.*, `model::String` implying that the results
+    are stored in CSV-files) does not support more than three indices for variables.
 """
 function GUI(
     case::Case;

src/utils_GUI/GUI_utils.jl

@@ -431,9 +431,10 @@ end
 
 Extract data from `var` having its time dimension at index `i_T` for all time periods in `periods`.
 
-!!! warning "Reading model results from csv-files"
-    This function does not support more than three indices for `var::DataFrame` (i.e., when 
-    model results are read from .csv-files).
+!!! warning "Reading model results from CSV-files"
+    This function does not support more than three indices for `var::DataFrame` (*i.e.*,
+    when model results are read from CSV-files). This implies it is incompatible with
+    potential extensions that introduce more than three indices for variables.
 """
 function extract_data_selection(
     var::SparseVars, selection::Vector, i_T::Int64, periods::Vector,
@@ -510,7 +511,7 @@ get_JuMP_dict(model::JuMP.Model) = object_dictionary(model)
     get_values(vals::JuMP.Containers.DenseAxisArray, ts::Vector)
     get_values(vals::DataFrame, ts::Vector)
 
-Get the values of the variables in `vals`. If a vector of time periods `ts` is provided, it 
+Get the values of the variables in `vals`. If a vector of time periods `ts` is provided, it
 returns the values for the times in `ts`.
 """
 get_values(vals::SparseVars) = isempty(vals) ? [] : collect(Iterators.flatten(value.(vals)))

src/utils_gen/export_utils.jl

@@ -157,7 +157,8 @@ end
 """
     export_to_file(gui::GUI)
 
-Export results based on the state of `gui` to file.
+Export results based on the state of `gui` to a file located within the folder specified
+through the `path_to_results` keyword of [`GUI`](@ref).
 """
 function export_to_file(gui::GUI)
     path = get_var(gui, :path_to_results)