Change string to Symbol in name docstring (#503)

rafaqz · Jul 27, 2023 · 95bf390 · 95bf390
1 parent 67dfb03
commit 95bf390
Showing 1 changed file with 5 additions and 5 deletions.
diff --git a/src/interface.jl b/src/interface.jl
@@ -116,12 +116,12 @@ or `Symbols` for `Dim{Symbol}`.
 function metadata end
 
 """
-    name(x) => String
-    name(xs:Tuple) => NTuple{N,String}
-    name(x, dims::Tuple) => NTuple{N,String}
-    name(x, dim) => String
+    name(x) => Symbol
+    name(xs:Tuple) => NTuple{N,Symbol}
+    name(x, dims::Tuple) => NTuple{N,Symbol}
+    name(x, dim) => Symbol
 
-Get the name of an array or Dimension, or a tuple of of either.
+Get the name of an array or Dimension, or a tuple of of either as a Symbol.
 
 Second argument `dims` can be `Dimension`s, `Dimension` types,
 or `Symbols` for `Dim{Symbol}`.