Skip to content

Commit

Permalink
[DOC] Fix typo in GC documentation
Browse files Browse the repository at this point in the history
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".
  • Loading branch information
alex-ross committed Feb 27, 2024
1 parent d7730d3 commit 5efe386
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions gc.rb
Expand Up @@ -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
Expand Down

0 comments on commit 5efe386

Please sign in to comment.