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

Allowed characters in labels/keys #17

Open
tsalo opened this issue Aug 3, 2020 · 3 comments
Open

Allowed characters in labels/keys #17

tsalo opened this issue Aug 3, 2020 · 3 comments
Labels
characters Proposals to change accepted characters throughout the specification.

Comments

@tsalo
Copy link
Member

tsalo commented Aug 3, 2020

https://docs.google.com/document/d/1HFUkAEE-pB-angVcYe6pf_-fVf4sCpOHKesUvfb8Grc/edit?disco=AAAAB1zsEbg

Some labels that are desired to be used consist of concatenated abbreviations, and would be more readable with a separator character (e.g., "32k-fs-LR"). This restriction seems excessive.

One possibility is to actually allow dashes in values, while keeping them forbidden in keys. This can still be parsed consistently by splitting everything on underscores, and then splitting each of those on the first dash.

If this is unpalatable, perhaps another cross-platform-allowed filename character can be added to the set of allowed characters, such as '=' or '+'. These are not as easy to read as a dash, but at least gives people an option for cases that are otherwise difficult to resolve.

Original authors: Unknown

@tsalo tsalo added the characters Proposals to change accepted characters throughout the specification. label Aug 3, 2020
@tsalo
Copy link
Member Author

tsalo commented Aug 3, 2020

@jbteves
Copy link

jbteves commented Aug 4, 2020

I disagree with allowing dashes only "sometimes" and thus giving them multiple possible meanings. It ultimately means more difficulty in writing parsers.

@yarikoptic
Copy link
Contributor

I would like to bring this back to "agenda" and do make - and + allowed. We are not to give any semantic, but rather just to allow file names to be more readable. For implementing support, it should be quite trivial since it doesn't add any ambiguity to parsers: split on _ into entities + optionally a suffix, and then split entities on - to separate key from value. The only possible difficulty is may be for regex based parsing.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
characters Proposals to change accepted characters throughout the specification.
Projects
Status: Todo
Development

No branches or pull requests

3 participants