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

[NIAC2020] reserved prefixes for names #49

Closed
FreddieAkeroyd opened this issue Oct 9, 2020 · 5 comments
Closed

[NIAC2020] reserved prefixes for names #49

FreddieAkeroyd opened this issue Oct 9, 2020 · 5 comments
Milestone

Comments

@FreddieAkeroyd
Copy link
Member

FreddieAkeroyd commented Oct 9, 2020

Discuss reserved prefixes for class, field and attributes

See nexusformat/definitions#769 and nexusformat/definitions#770

Proposed for discussion by @mkoennecke

@FreddieAkeroyd FreddieAkeroyd added this to the NIAC 2020 milestone Oct 9, 2020
@benajamin
Copy link
Contributor

Proposal is to reserve name prefixes for specific use.

  • thumbs up to accept
  • thumbs down to reject
  • any other emoji to abstain

@benajamin
Copy link
Contributor

benajamin commented Oct 12, 2020

Proposal is to reserve the following prefixes:

prefix use meaning URL
IDF_ attributes reserved for use by ISIS Muon Facility www.isis.stfc.ac.uk
NX NXDL class For the class names used with NeXus groups www.nexusformat.org
NX_ attributes reserved for use by NeXus www.nexusformat.org
PDBX_ attributes reserved for the US protein data bank www.rcsb.org
SAS_ attributes reserved for use by canSAS www.cansas.org/
SILX_ attributes reserved for use by silx www.silx.org
NDAttr attributes reserved for use by EPICS area detector https://github.com/areaDetector

Prefixes should follow a naming scheme of uppercase letters followed by an underscore, but exceptions will be made for cases already in wide use.

  • thumbs up to accept
  • thumbs down to reject
  • any other emoji to abstain

@benajamin
Copy link
Contributor

benajamin commented Oct 12, 2020

Proposal is to allow the set of reserved prefixes to be managed by email voting:

  • thumbs up to accept
  • thumbs down to reject
  • any other emoji to abstain

The only management delegated to the technical committee is to add to the list. For discussion or to remove items from the list, the NIAC should be consulted before any changes are made.

@prjemian
Copy link
Contributor

The only management delegated to the technical committee is to add to the list.

@benajamin
Copy link
Contributor

Proposal to reserve name prefixes is accepted with 14 votes in favour and 1 against.
Proposal to accept set of prefixes (see above) is accepted with 15 votes in favour and 1 against.
Proposal to allow the technical committee to add new prefixes is accepted with 14 votes in favour and 1 against.
Implemented via nexusformat/definitions#808

Note that a further prefix was proposed and accepted in #80

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

3 participants