VDA5050 / VDA5050

Official Specification document for the VDA 5050
https://www.vda.de/en/search#%225050%22
MIT License
231 stars 95 forks source link

[Change Request] Naming convention discrepancy fixes #109

Open Tirine opened 2 years ago

Tirine commented 2 years ago

I know this is a quite wide impacting change, but I find the naming convention not being followed at all times is quite a nuisance.

  1. Either use shortenings (And maybe define them somewhere if they are unclear) or you don't at all. Specially these bugs me, there might be more:

    • Info vs Information: The first being a shortening of the second, these are used in the same place in multiple places, even mixing both with the singular and plural forms.
    • Len vs Length: Length is used almost everywhere, except for in Facesheet schema where all of a sudden everything is "len"
    • Suggestion:
      • Don't use shortenings except for a small number of defined glossary shortnings, like AGV or MQTT and extremely obvious like 'id' (but to keep consistency, if never then use 'identification' or 'identity' etc.) .
  2. Specific objects are plural or they are not:

    • An array is plural or it's not, his is at multiple places, but as an example: In the state schema there is the arrays that are plurals, nodeStates and loads, but then suddenly there is one that is singular, information, or in the order schema at order.edges is an array that is plural of the object edge, which hold the object action which is also an array, but is singular, buuut if you go on order.nodes, there instead there is an object actions (Edit: this seems to be a typo in the docs, now that I look at the schema files is's actions. So that typo should be fixed 😄 But then it's only the 'information' that is singular but an array. I guess the argument can be made that the plural itself is also 'information', as it's an 'uncountable' word, but this is an array of several information objects, and such the array is a plural, so it's name should be 'informations'.)
    • There is also objects that are a collection of other values, could be plural but are singular, other objects that are collection of objects that are plural: Example: state.velocity is an object that is a collection of values, but singular. But the state.loads.loadDimensions is also an object that is a collection of values, but plural.
    • Suggestion:
      • Arrays are always plural or named 'array', 'vector' or 'list' etc..
      • Collections of objects are singular, it is a collection, also to clarify that it is not an array of the specific object.

    These are just examples, there is loads of these discrepancies that should be fixed.

ConstantinUp commented 2 years ago

VDA/VDMA: This would be a breaking change. We have to discuss that, when a majer version change is coming up.