LionWeb-io / specification

Specifications of the LionWeb initiative
http://lionweb.io/specification/
6 stars 0 forks source link

Define standard annotation language for M2 documentation #290

Open enikao opened 1 week ago

enikao commented 1 week ago

In https://github.com/LionWeb-io/lionweb-mps/pull/94, we've added annotations on exported language elements to keep MPS' shortDescription and conceptAlias in the export. We're using this in https://github.com/LionWeb-io/lionweb-csharp/pull/13.

However, this is a very MPS-specific solution. A platform-agnostic language to store such annotations would be better.

dslmeinte commented 1 week ago

Would it make sense to add these annotations to the Builtins language?

enikao commented 1 week ago

I don't think so: Builtins is for stuff the system absolutely doesn't work without -- I'd like to keep it as small as possible. These kind of descriptions are useful, but not necessary at all. An implementation can perfectly work without supporting descriptions, I would not like to force support.