* gc.c: [DOC] Fix call-seq for GC.start by @jasonrclark [Fixes GH-572]

  https://github.com/ruby/ruby/pull/572 [ci skip]


git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@45377 b2dd03c8-39d4-4d8f-98ff-823fe69b080e

2 files changed, 8 insertions, 3 deletions

diff --git a/ChangeLog b/ChangeLog
index 2ecf045954..80f3ab3b98 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,8 @@
+Fri Mar 21 16:31:56 2014  Zachary Scott  <e@zzak.io>
+
+	* gc.c: [DOC] Fix call-seq for GC.start by @jasonrclark [Fixes GH-572]
+	  https://github.com/ruby/ruby/pull/572
+
 Thu Mar 20 11:37:28 2014  James Edward Gray II  <james@graysoftinc.com>
 
 	* lib/csv.rb: Fixed a broken regular expression that was causing
diff --git a/gc.c b/gc.c
index 081d26adf7..81c62fbb20 100644
--- a/gc.c
+++ b/gc.c
@@ -5138,14 +5138,14 @@ Init_stack(volatile VALUE *addr)
  *  call-seq:
  *     GC.start                     -> nil
  *     GC.garbage_collect           -> nil
- *     ObjectSpace.garbage_collect  -> nil
- *     GC.start(full_mark: false)   -> nil
+ *     GC.start(full_mark: true, immediate_sweep: true)           -> nil
+ *     GC.garbage_collect(full_mark: true, immediate_sweep: true) -> nil
  *
  *  Initiates garbage collection, unless manually disabled.
  *
  *  This method is defined with keyword arguments that default to true:
  *
- *     def GC.start(full_mark: true, immediate_sweep: true) end
+ *     def GC.start(full_mark: true, immediate_sweep: true); end
  *
  *  Use full_mark: false to perform a minor GC.
  *  Use immediate_sweep: false to defer sweeping (use lazy sweep).