Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve docs for Domain and Dimension in Terminology #2493

Open
RaananHadar opened this issue Sep 8, 2021 · 1 comment
Open

Improve docs for Domain and Dimension in Terminology #2493

RaananHadar opened this issue Sep 8, 2021 · 1 comment

Comments

@RaananHadar
Copy link

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 RaananHadar changed the title Improve docs for Domain and Dimensions in Terminology Improve docs for Domain and Dimension in Terminology Sep 8, 2021
@stavrospapadopoulos
Copy link
Member

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants