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.

Sign up for GitHub

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

Jump to bottom

Add tip re: keys with different dimensionality #130

Open

khaeru opened this issue Feb 9, 2024 · 0 comments

Labels

doc enh good first issue

Owner

khaeru commented Feb 9, 2024 •

edited

Loading

With keys like:

<foo:a-b-c:bar>
<foo:a-d-e:bar>

—that is, distinct full dimensionality with ≥1 overlapping dimension and same tags—it becomes ambiguous whether <foo:a:bar> refers to:

Partial sum over dimensions (b, c) of (1).
Partial sum over dimensions (d, e) of (2).

Some remedies:

Add a tip to the docs in an appropriate location to advise using different keys like <foo:a-b-c:bar> and <foo:a-d-e:baz>.
Actually check new keys against existing in Computer.add() and similar methods; warn users or raise an exception.

khaeru added doc enh good first issue labels

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment