lauwers
commented
2 years ago When deciding whether a keyname is mandatory or not, we should only consider the initial definition case, not any refinements (since in refinements all keynames are non-mandatory).
From: Tal Liron @.> Sent: Tuesday, March 15, 2022 8:28 AM To: oasis-open/tosca-community-contributions @.> Cc: Subscribed @.***> Subject: [oasis-open/tosca-community-contributions] Remove use of word "optional" in "Description" column for keyname tables (Issue #95)
Example:
Keyname: repository Mandatory: no Description: The optional name of the repository definition which contains the location of the external repository that contains the artifact. The artifact is expected to be referenceable [sic] by its file URI within the repository.
The word "optional" is entirely unnecessary due to the existence of "Mandatory: no". Worse, it is confusing. Is the keyname optional? Or is the name of the repository optional? The spec is rife with this kind of confusing and unnecessary language.
Please let's remove this unnecessary "optional" wording from the entire spec.
— Reply to this email directly, view it on GitHubhttps://github.com/oasis-open/tosca-community-contributions/issues/95, or unsubscribehttps://github.com/notifications/unsubscribe-auth/AASPLIM5NBZLOA57FGFR5J3VACUAFANCNFSM5QZBLPTA. Triage notifications on the go with GitHub Mobile for iOShttps://apps.apple.com/app/apple-store/id1477376905?ct=notification-email&mt=8&pt=524675 or Androidhttps://play.google.com/store/apps/details?id=com.github.android&referrer=utm_campaign%3Dnotification-email%26utm_medium%3Demail%26utm_source%3Dgithub. You are receiving this because you are subscribed to this thread.Message ID: @.**@.>>
Example:
The word "optional" is entirely unnecessary due to the existence of "Mandatory: no". Worse, it is confusing. Is the keyname optional? Or is the name of the repository optional? The spec is rife with this kind of confusing and unnecessary language.
Please let's remove this unnecessary "optional" wording from the entire spec.