Activity
@mtross What is correct form?
dsdevice
ordsDevice
?The main question is whether you consider it one word or two words.
- I see it as
dsDevice
in https://git.digitalstrom.org/digitalstrom-documentation/public-api-documentation/blob/master/service/apartment/apartment_model.apib. - I see it as
dsdevice
member anddSDevice
type in https://git.digitalstrom.org/digitalstrom-documentation/digitalstrom-documentation/raw/master/datamodel/apartment_structure.md
I suggest to use
dsDevice
for member andDsDevice
for type.I suggest to avoid
dS
in model and in api ... to use it only for branding purposes.Edited by Christian Hitz- I see it as
The "dS" prefix is commonly used in documentation, it is not only branding. The model contains class name
dSDevice
and member namedsdevice
, in API document apartment_model.apib you already requested to change member name todsDevice
to comply to camel-case convention. The class name can bedSDevice
orDSDevice
(like today in dss).Do we agree these conventions in model?
- class names starts with upper case ...
CamelCase
? - members starts start with lower case ...
camelCase
?
I would like to come with rule for for abbreviations (
DS
in this case):- like normal word? I.e.
dsDevice
,DsDevice
- all letters follow the case of the first letter? I.e.
dsDevice
,DSDevice
- ???
Edited by Branislav Katreniak- class names starts with upper case ...
I clarified with @mtross.
The right form is
dsDevices
. The identifier is composed of 2 words and usescamelCase
. We will fix the model documentation.mentioned in merge request !1282 (merged)