Merge pull request #105 from WIAS-PDELib/fix/docs-legend

Minor doc fixes in `default_plot_kwargs`

Author: pjaap

.pre-commit-config.yaml

@@ -12,7 +12,7 @@ repos:
   - id: no-commit-to-branch
     args: [--branch, main]
 - repo: https://github.com/gitleaks/gitleaks
-  rev: v8.29.0
+  rev: v8.30.0
   hooks:
   - id: gitleaks
 - repo: https://github.com/fredrikekre/runic-pre-commit

src/dispatch.jl

@@ -348,7 +348,7 @@ function default_plot_kwargs()
         :levels => Pair(7, "array of isolevels or number of isolevels for contour plots"),
         :legend => Pair(
             :none,
-            "Legend (position): one of [:none, :best, :lt, :ct, :rt, :lc, :rc, :lb, :cb, :rb]"
+            "Legend (position): one of [:none, :best, :cc, :lt, :ct, :rt, :lc, :rc, :lb, :cb, :rb]"
         ),
         :limits => Pair((1, -1), "function limits"),
         :linestyle => Pair(
@@ -413,7 +413,9 @@ end
 function _myprint(dict)
     lines_out = IOBuffer()
     for (k, v) in dict
-        println(lines_out, "  - `$(k)`: $(v[2]). Default: `$(v[1])`\n")
+        # add ":" to symbols
+        default_value = "`$(typeof(v[1]) == Symbol ? ":" : "")$(v[1])`"
+        println(lines_out, "  - `$(k)`: $(v[2]). Default: $(default_value)\n")
     end
     return String(take!(lines_out))
 end