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

Naming conventions: Requirements, Reqs, Definitions and Defs #714

Closed
MarAlder opened this issue May 4, 2021 · 3 comments
Closed

Naming conventions: Requirements, Reqs, Definitions and Defs #714

MarAlder opened this issue May 4, 2021 · 3 comments
Assignees
Milestone

Comments

@MarAlder
Copy link
Collaborator

MarAlder commented May 4, 2021

Problem

Due to the length of the word Requirements, we have chosen the abbreviation Reqs when revising the performanceRequirements for CPACS 3.3. This may result in long XPath strings. However, it was noted that this is inconsistent with other node names where we write out Definitions and do not abbreviate to Defs.

grafik

Proposals

  1. We also abbreviate Definitions (resp. Definition) as Defs (resp. Def).
  2. We keep the current state as Requirements is a bit longer than Definitions and then sometimes use abbreviations and sometimes not.
  3. We consistently write out everything according to the motto: as expressive as possible. In the XML file the tags are listed underneath anyway and for the XPath strings linebreaks could be used.

I prefer solution 3. What do you all think?

@ErwinMoerland
Copy link

I prefer solution 3. The 'delta' in XPath length achieved due to using abbreviations does not seem too large (saving a couple of characters compared to an already relatively long xpath). I do prefer the 'as expressive as possible' motto here.

@CarstenChristmann
Copy link

Although I prefer shorter names I vote for the proposal which causes a minimum of necessary changes in the released schema V3.2. This will reduce the impact on already existing tools.

@MarAlder
Copy link
Collaborator Author

closed by #716

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

No branches or pull requests

3 participants