Replies: 1 comment
-
It would be great if we can compile here the references. |
Beta Was this translation helpful? Give feedback.
0 replies
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
-
Inspired by a comment in #1912, there is a proposal to include a references or sources for definitions. This is important for documentation and traceability reasons. This discussion is to bikeshed the actual format and implementation.
source
orreference
?. I will usesource
but this is open.This would require first a public API to access definitions (which I think is a good idea!).
Such definition could have a
source
attribute.This source will be applied to all definitions within that file.
PRO: it is super easy to read and implement.
CON: would require a definition file for each source.
I think it would be good to list the sources first.
PRO: very flexible, only one definition file is needed.
CON: it clutters the definition file and requires more time to implement
Beta Was this translation helpful? Give feedback.
All reactions