Explain preferredName and description better - Githubissues

eclipse-esmf / esmf-semantic-aspect-meta-model

Formal and textual specification of the Semantic Aspect Meta Model (SAMM)

https://eclipse-esmf.github.io/samm-specification/snapshot/index.html

Mozilla Public License 2.0

46 stars 9 forks source link

Explain preferredName and description better #304

Open chris-volk opened 1 month ago

chris-volk commented 1 month ago

Explain preferredName and description better to avoid duplicating the name

Description

Please include a summary of the changes and the related issue. List any dependencies that are required for this change.

Fixes #(number of issue in GitHub)

Type of change

Please delete options that are not relevant.

[ ] Bug fix (non-breaking change which fixes an issue)
[ ] New feature (non-breaking change which adds functionality)
[ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)

Checklist:

[ ] My code follows the style guidelines of this project
[ ] I have performed a self-review of my own code
[ ] I have commented my code, particularly in hard-to-understand areas
[x] I have made corresponding changes to the documentation
[ ] My changes generate no new warnings
[ ] I have added tests that prove my fix is effective or that my feature works

Additional notes:

Only doc changed