Merge pull request #4154 from yglukhov/sizeof-doc

Added limitations note to sizeof. Closes #4153.

1 files changed, 3 insertions, 0 deletions

diff --git a/lib/system.nim b/lib/system.nim
index f584f7590..cb98bcc5f 100644
--- a/lib/system.nim
+++ b/lib/system.nim
@@ -588,6 +588,9 @@ proc sizeof*[T](x: T): int {.magic: "SizeOf", noSideEffect.}
   ## that one never needs to know ``x``'s size. As a special semantic rule,
   ## ``x`` may also be a type identifier (``sizeof(int)`` is valid).
   ##
+  ## Limitations: If used within nim VM context ``sizeof`` will only work
+  ## for simple types.
+  ##
   ## .. code-block:: nim
   ##  sizeof('A') #=> 1
   ##  sizeof(2) #=> 8