From 95bf3903191f58d976efbf87f3e360e0f7fc6f00 Mon Sep 17 00:00:00 2001 From: Felix Cremer Date: Thu, 27 Jul 2023 19:45:32 +0200 Subject: [PATCH] Change string to Symbol in name docstring (#503) --- src/interface.jl | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/src/interface.jl b/src/interface.jl index a03d568f6..ee99298e0 100644 --- 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}`.