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 terminology - attributes, members, elements, meta data #733

Open
ppb2020 opened this issue Mar 13, 2024 · 3 comments
Open

Inconsistent terminology - attributes, members, elements, meta data #733

ppb2020 opened this issue Mar 13, 2024 · 3 comments

Comments

@ppb2020
Copy link
Collaborator

ppb2020 commented Mar 13, 2024

I have noticed that the documentation and tools are not consistent in using terminology to describe the elements that define the meta data for a node (such as type, datatype, description, etc.).

Under the document for Branches, these are referred to as "elements". Under the document for Data Entry, the more general "metadata" term is used. Under the document for "Sensors & Actuators", the term "members" is used. Lastly, vss-tools refer to the same as "attributes", a usage that can be confused with nodes that define attribute types.

I propose rationalizing this by using the term "element" everywhere and, perhaps, metadata in some places where we refer in documentation to the set of elements used to define a node.

I can start putting together a set of changes to align this terminology across the specification, its documentation, and the tools. I'd probably fix up a few typos I have come across as well at the same time... Any objections?

@erikbosch
Copy link
Collaborator

No objections, rather the opposite. We need to consider what changes that will be needed (long term) in vss-tools, as some arguments there include the term "attribute". I suggest us to discuss and try to agree on terms in VSS-meeting before you start doing search/replace everywhere.

@erikbosch
Copy link
Collaborator

MoM:

  • Please discuss; do you think element is a good name
  • Daniel: There is room for improvement, could be considered as label, or keys
  • Continue discussion next week

@ppb2020
Copy link
Collaborator Author

ppb2020 commented Mar 26, 2024

Perhaps a topic for the AMM?

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

2 participants