Skip to content

Commit 1164d09

Browse files
committed
(render TODOs expllicitly)
1 parent 51c8bd2 commit 1164d09

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

documentation/correctness.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -99,25 +99,25 @@ Note that this doesn't require any knowledge of the metamodels, as it just invol
9999
This means that the serialization chunk doesn't need to be correct in the meta-referential nor in the meta-structural sense!
100100
It should be alway possible to deserialize the serialization chunk into "`dynamic`"/"`reflective`" nodes, which could be useful in its own right.
101101

102-
// TODO describe when and how links should be resolved, etc.
102+
**TODO:** describe when and how links should be resolved, etc.
103103

104104
=== Constraints
105105

106106
No constraint violations.
107107
Constraints can only be checked with full knowledge of all metamodels involved, so meta-referential, meta-structural correctness is necessary for this.
108108
Also: the more "`interesting`" constraints typically navigate across references, so structure-referential correctness would also be necessary.
109109
It should be possible to come up with some kind of "`partial constraint checking`" that deals with unresolved references in a meaningful way -- possibly reporting warnings, rather than outright constraint violations.
110-
// TODO come up with a "partial evaluation"-style semantics for navigating over an unresolved link, and e.g. type computation
110+
**TODO:** come up with a "partial evaluation"-style semantics for navigating over an unresolved link, and e.g. type computation
111111

112112
Incorrectness is to be reported as a model with references to nodes, as well as an appropriate error message.
113113
For multi-valued features, an index has to be included as well.
114114
Recovery is more-or-less irrelevant from a technical standpoint, but incorrectness might obstruct/impede code generation, interpretation, type computation, etc.
115115

116116

117-
// TODO example of how to report violations of all stated kinds
117+
**TODO:** example of how to report violations of all stated kinds
118118

119119

120-
**TODO** improve following diagram:
120+
**TODO:** improve following diagram:
121121

122122
image::../resources/correctness-diagrams/levels.svg[align="center"]
123123

0 commit comments

Comments
 (0)