NCEAS / metacatui

MetacatUI: A client-side web interface for DataONE data repositories
https://nceas.github.io/metacatui
Apache License 2.0
41 stars 27 forks source link

Adopt @namespace tag for nested types in JSDoc #2450

Open robyngit opened 3 months ago

robyngit commented 3 months ago

In MetacatUI, we have a lot of nested types that are defined in a parent type. For example, MapConfig has a nested type CameraPosition. Currently, we use # to separate the parent type and the nested type, like MapConfig#CameraPosition. However, this syntax is not supported in all cases with ESLint. The issue entails switching to the @namespace tag to define nested types (as cleverly suggested by @yvonnesjy).

The syntax namespace#nestedType is allowed when defining @typedefs, but not when defining @propertys or @params. However, we need to be able to refer to these custom types in all cases.

See: