Add draft of standard definitions of list operators to user manual and as a regression #152
Conversation
… into listDefStdReg
|
@hansjoergschurr this is now updated to contain |
| definition `$eo_X` in the following signature. | ||
| Including this signature and modifying a Eunoia | ||
| file to use `$eo_` instead of `eo::` should | ||
| have no impact on behavior (apart from performance), unless otherwise noted. |
There was a problem hiding this comment.
I think we should refer to the encoding file here instead of including the definitions. Otherwise, the files will inadvertently diverge.
I think that the comments about the lists operators that only show up after a long list of definitions will be missed by many readers.
There was a problem hiding this comment.
I think I agree. I'll refactor this.
| ; Returns true if t and s are equivalent values (ground and fully evaluated). | ||
| ; define: $eo_is_eq | ||
| ; implements: eo::is_eq | ||
| (define $eo_is_eq ((T Type :implicit) (S Type :implicit) (t T) (s S)) |
There was a problem hiding this comment.
one small thing: the documentation says these are Eunoia programs, but most here are define i.e., macros. Maybe the documentation should say that it's either.
tests/eo-definitions.eo
Outdated
|
|
||
| ;;; $eo_cmp | ||
|
|
||
| ; An arbitrary deterministic comparison of terms. Returns true if a > b based |
There was a problem hiding this comment.
we should be very precise about the assumptions here.
IIRC this ordering can be different from run to run?
There was a problem hiding this comment.
This definition is accurate, but the documentation indeed is a bit misleading. Saying "arbitrary" here summarizes the behavior, but indeed it isn't arbitrary: it is determined by eo::hash. I'll update the doc.
|
I've addressed the review, PTAL |
Also adds a test to confirm that the builtin operators behave as the builtin ones, based on the examples from the user manual.
It also makes the contents of this regression part of the user manual.