prelude: add note about docs_main

crystal-lang · Jun 2, 2016 · 19c1b13 · 19c1b13
1 parent 4d9ee07
commit 19c1b13
Showing 1 changed file with 4 additions and 1 deletion.
diff --git a/src/prelude.cr b/src/prelude.cr
@@ -2,7 +2,10 @@
 # macros need to be defined before they are used.
 # A first compiler pass gathers all classes and methods, removing the
 # requirement to place these in load order.
-# When adding new files, use alpha-sort when possible.
+#
+# When adding new files, use alpha-sort when possible. Make sure
+# to also add them to `docs_main.cr` if their content need to
+# appear in the API docs.
 
 # This list requires ordered statements
 require "lib_c"