From f3c95ff3b8dc0da7060c6bda75c513cfc28a8eee Mon Sep 17 00:00:00 2001 From: ben Date: Mon, 14 Dec 2015 03:28:07 -0500 Subject: [PATCH] ** note on naming --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/README.md b/README.md index 969ce2d..b7dc9ee 100644 --- a/README.md +++ b/README.md @@ -70,6 +70,15 @@ Each file in the root directory of this repo can be imported specifically, as in These files only export macros. +Naming +--- + +- The library is "trivial" because it solves only the simplest typechecking problems, and does so simply by analyzing a local chunk of source code. + +- By convention, we suffix all our exports with a trailing colon. + This is a hint that the macro will attempt some extra static analysis (including typechecking) at its call-site. + + Contributing ---