links
links copied to clipboard
Missing documentation
Syntax that isn't documented
- [ ] unsafe
Built-in library functions that aren't listed in @builtins and not documented
- [ ] addRoute (currently there is only wiki documentation)
- [ ] serveThis, serveThese (currently there is only wiki documentation and it doesn't include the
hear
effect in the sig)
I think that unsafe
not being documented should be considered a feature, hehe. :-)))) As for addRoute
I am eager to get rid of it altogether, because it are a great source of internal complexity in Links -- and it is anti-modular and at odds with the long term goal of separate compilation. It would still be good to document it and possibly remark that it is likely to be deprecated in the future.
I think unsafe
should be documented (it is in the prelude) and the documentation should say don't use it. We could even make it an error to use it outside of the prelude, since it should only be used for functions that the query compiler knows about.