Documentation staticRead maximum file size limits (#13485)

nim-lang · Feb 26, 2020 · 94b0d6b · 94b0d6b
1 parent 5d2483f
commit 94b0d6b
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/lib/system.nim b/lib/system.nim
@@ -2525,6 +2525,9 @@ proc staticRead*(filename: string): string {.magic: "Slurp".}
   ## Compile-time `readFile <io.html#readFile,string>`_ proc for easy
   ## `resource`:idx: embedding:
   ##
+  ## The maximum file size limit that ``staticRead`` and ``slurp`` can read is
+  ## near or equal to the *free* memory of the device you are using to compile.
+  ##
   ## .. code-block:: Nim
   ##     const myResource = staticRead"mydatafile.bin"
   ##