archive/ruby
1
0
Fork 0
mirror of https://github.com/ruby/ruby.git synced 2025-08-15 13:39:04 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 4

[DOC] Fix typo in GC documentation

Browse source 
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".
This commit is contained in:
Alexander Ross 2024-02-27 12:19:02 +01:00 • committed by GitHub
parent d7730d3a0b
commit 5efe386c89
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 3 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

6
gc.rb
View file

@ -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