Skip to content

Commit

Permalink
Spelling and Grammer fixes (#15719)
Browse files Browse the repository at this point in the history
Co-authored-by: Tim Smith <tim.smith.hdg@gmail.com>
Co-authored-by: Miran <narimiran@disroot.org>
(cherry picked from commit 485d4ff)
  • Loading branch information
timscodebase authored and narimiran committed Nov 5, 2020
1 parent 60403c9 commit 4a95d45
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions doc/gc.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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,
deactivate the garbage collector with ``GC_disable`` at program startup.
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,
if there is not much garbage to collect.
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
references below a certain point on the stack. Make sure the size you specify
is greater than the potential worst-case size.
Expand Down Expand Up @@ -174,7 +178,7 @@ Heap dump
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
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
amount of bytes these instances take up. This list is currently unsorted!
You need to use external shell script hacking to sort it.
Expand Down

0 comments on commit 4a95d45

Please sign in to comment.