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

Inconsistent use of sigil, handle and label #49

Open
vvvyyynet opened this issue Feb 10, 2025 · 0 comments
Open

Inconsistent use of sigil, handle and label #49

vvvyyynet opened this issue Feb 10, 2025 · 0 comments
Labels
documentation Improvements or additions to documentation low prio
Milestone

Comments

@vvvyyynet
Copy link
Collaborator

The use of the following variables is inconsistent, which should be documented or fixed at some point: sigil/sigla, humanReadableSigil, handle, label.

In fact they could be reduced to:

  1. siglaHandle/siglaHandle: "nk" (for "n klein") or "fr5"
  2. sigil/sigla: "n" or "Fr. 5 (d)"

Currently, label and humanReadableSigil (as well as sigla in the searchIndex.json files) are used for (1) whereas handle, sigil/sigla and are used for (2).

The inconsistency originates from the .json files (as stated in @vvvyyynet in #40 (comment)_): metadata-nomenclature.json uses sigla and handle correctly, whereas searchIndex.json incorrectly uses sigla for the handles. Currently this is compensated for in the frontend, introducing confusing name choices.

Originally posted by @vvvyyynet in #40 (comment)

@flicksolutions flicksolutions added the documentation Improvements or additions to documentation label Feb 13, 2025
@flicksolutions flicksolutions added this to the 1.1 milestone Feb 13, 2025
@vvvyyynet vvvyyynet changed the title Inconsistent use of sigil, handle and label (low-prio) Inconsistent use of sigil, handle and label Feb 14, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation low prio
Projects
None yet
Development

No branches or pull requests

2 participants