Added docstring

JuliaGeodynamics · Mar 6, 2025 · f4f80a6 · f4f80a6
1 parent ed90ca2
commit f4f80a6
Showing 1 changed file with 5 additions and 2 deletions.
diff --git a/src/Units.jl b/src/Units.jl
@@ -986,8 +986,11 @@ function Unitful.superscript(i::Float64)
     end
 end
 
-function upgrade_GeoUnits(a) 
-    return GEO_units(length = a.length, temperature = a.temperature, stress = a.stress, viscosity = a.viscosity) 
+"""
+Function which recreates an outdated `GeoUnits` object in line with the current format
+"""
+function upgrade_GeoUnits(a)
+    return GEO_units(length = a.length, temperature = a.temperature, stress = a.stress, viscosity = a.viscosity)
 end
 
 end