Skip to content

Commit 94b0d6b

Browse files
Documentation staticRead maximum file size limits (#13485)
1 parent 5d2483f commit 94b0d6b

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed

lib/system.nim

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2525,6 +2525,9 @@ proc staticRead*(filename: string): string {.magic: "Slurp".}
25252525
## Compile-time `readFile <io.html#readFile,string>`_ proc for easy
25262526
## `resource`:idx: embedding:
25272527
##
2528+
## The maximum file size limit that ``staticRead`` and ``slurp`` can read is
2529+
## near or equal to the *free* memory of the device you are using to compile.
2530+
##
25282531
## .. code-block:: Nim
25292532
## const myResource = staticRead"mydatafile.bin"
25302533
##

0 commit comments

Comments
 (0)