TileDB icon indicating copy to clipboard operation
TileDB copied to clipboard

Improve docs for Domain and Dimension in Terminology

Open RaananHadar opened this issue 4 years ago • 1 comments

Dimension and Domain are core concepts that are heavily utilized in TileDB. It is important that their core explanation will be very clear to the user.

The documentation page could be clearer, here are my main issues:

The array domain (or simply domain) is the hyperspace defined by the domains of the array dimensions.
  • The definition of "Domain" is recursive and makes use of the term "Domain".
  • The definitions of both Domain and Dimension are entangled. Domain is defined both in terms of Domain and Dimension and Dimension is defined both using the terms Domain and Dimension. I understand that Dimension is an object that is composed of multiple attributes, one of which, is the Domain. But the Domain definition should not have circular logic and refer back to Dimension...

How do I suggest to solve this?

  • I think its best to make the definition of Domain should be first and should not include the use of Dimension.
  • Then the definition of Dimension should appear after the definition of Domain has been establish and can make use of the term Domain.

RaananHadar avatar Sep 08 '21 10:09 RaananHadar

Thanks @RaananHadar! I am actually refactoring the docs as we speak, so I'll consider your suggestion here.

stavrospapadopoulos avatar Sep 09 '21 18:09 stavrospapadopoulos