jyapayne/Nim
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Spelling and Grammer fixes (#15719)

Browse source 
Co-authored-by: Tim Smith <tim.smith.hdg@gmail.com>
Co-authored-by: Miran <narimiran@disroot.org>
This commit is contained in:
Tim Smith 2020-10-28 09:56:56 -07:00 • committed by GitHub
commit 485d4ff802
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 6 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

8
doc/gc.rst
View file

@ -102,10 +102,14 @@ These two procs are the two modus operandi of the real-time garbage collector:
To bind all garbage collector activity to a ``GC_step`` call, To bind all garbage collector activity to a ``GC_step`` call,
deactivate the garbage collector with ``GC_disable`` at program startup. deactivate the garbage collector with ``GC_disable`` at program startup.
If ``strongAdvice`` is set to ``true``, If ``strongAdvice`` is set to ``true``,
then the garbage collector will be forced to perform collection cycle. then the garbage collector will be forced to perform the collection cycle.
Otherwise, the garbage collector may decide not to do anything, Otherwise, the garbage collector may decide not to do anything,
if there is not much garbage to collect. if there is not much garbage to collect.
You may also specify the current stack size via ``stackSize`` parameter. You may also specify the current stack size via ``stackSize`` parameter.
It can improve performance when you know that there are no unique Nim references
below a certain point on the stack. Make sure the size you specify is greater
than the potential worst-case size.
It can improve performance when you know that there are no unique Nim It can improve performance when you know that there are no unique Nim
references below a certain point on the stack. Make sure the size you specify references below a certain point on the stack. Make sure the size you specify
is greater than the potential worst-case size. is greater than the potential worst-case size.
@ -174,7 +178,7 @@ Heap dump
The heap dump feature is still in its infancy, but it already proved The heap dump feature is still in its infancy, but it already proved
useful for us, so it might be useful for you. To get a heap dump, compile useful for us, so it might be useful for you. To get a heap dump, compile
with ``-d:nimTypeNames`` and call ``dumpNumberOfInstances`` at a strategic place in your program. with ``-d:nimTypeNames`` and call ``dumpNumberOfInstances`` at a strategic place in your program.
This produces a list of used types in your program and for every type This produces a list of the used types in your program and for every type
the total amount of object instances for this type as well as the total the total amount of object instances for this type as well as the total
amount of bytes these instances take up. amount of bytes these instances take up.