diff options
| author | Alexander Ross <ross@standout.se> | 2024-02-27 12:19:02 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2024-02-27 11:19:02 +0000 |
| commit | 5efe386c89537d86d5a267843ac5da83083baaf5 (patch) | |
| tree | abb757da8dcdd04977d750eb16f0deed75e2d4d1 | |
| parent | d7730d3a0bd683b4d1c6f85763de7f0db7b0acf8 (diff) | |
[DOC] Fix typo in GC documentation
The documentation for GC.start was incorrect. It said that the
`immediate_sweep` keyword argument would defer sweeping when set to
`true`, but it should have said that it would defer sweeping when set to
`false`.
The commit will also fix the typo "immedate_sweep" to "immediate_sweep".
| -rw-r--r-- | gc.rb | 6 |
1 files changed, 3 insertions, 3 deletions
@@ -26,10 +26,10 @@ module GC # then marking will always be immediate, regardless of the value of # +immediate_mark+. # - # The +immedate_sweep+ keyword argument determines whether or not to defer - # sweeping (using lazy sweep). When set to +true+, sweeping is performed in + # The +immediate_sweep+ keyword argument determines whether or not to defer + # sweeping (using lazy sweep). When set to +false+, sweeping is performed in # steps that is interleaved with future Ruby code execution, so sweeping might - # not be completed during this method call. When set to +false+, sweeping is + # not be completed during this method call. When set to +true+, sweeping is # completed during the call to this method. # # Note: These keyword arguments are implementation and version dependent. They |
