Forum: Ruby-core [ruby-trunk - Bug #7656][Open] Handful of documentations

Issue #7656 has been reported by vbatts (Vincent Batts).

----------------------------------------
Bug #7656: Handful of documentations
https://bugs.ruby-lang.org/issues/7656

Author: vbatts (Vincent Batts)
Status: Open
Priority: Normal
Assignee: zzak (Zachary Scott)
Category: DOC
Target version: 2.0.0
ruby -v: ruby 2.0.0dev (2012-12-08) [i686-linux]


This fixes documentation in ENV, adds a little for debug.rb, and 
completes PP

Issue #7656 has been updated by zzak (Zachary Scott).


Awesome, thank you!!
----------------------------------------
Bug #7656: Handful of documentations
https://bugs.ruby-lang.org/issues/7656#change-35222

Author: vbatts (Vincent Batts)
Status: Open
Priority: Normal
Assignee: zzak (Zachary Scott)
Category: DOC
Target version: 2.0.0
ruby -v: ruby 2.0.0dev (2012-12-08) [i686-linux]


This fixes documentation in ENV, adds a little for debug.rb, and 
completes PP

Issue #7656 has been updated by vbatts (Vincent Batts).


Is there anything I can do better?
----------------------------------------
Bug #7656: Handful of documentations
https://bugs.ruby-lang.org/issues/7656#change-35473

Author: vbatts (Vincent Batts)
Status: Open
Priority: Normal
Assignee: zzak (Zachary Scott)
Category: DOC
Target version: 2.0.0
ruby -v: ruby 2.0.0dev (2012-12-08) [i686-linux]


This fixes documentation in ENV, adds a little for debug.rb, and 
completes PP

Issue #7656 has been updated by zzak (Zachary Scott).


vbatts (Vincent Batts) wrote:
> Is there anything I can do better?

These are good, for small changes I don't mind grouping them into one 
patch, though I'll probably commit them separately.

I noticed a few small spelling errors, like usage vs useage, but nothing 
I can't handle myself.

Sorry for dragging my feet on these, but you're doing a good job 
Vincent. Thank you!

----------------------------------------
Bug #7656: Handful of documentations
https://bugs.ruby-lang.org/issues/7656#change-35486

Author: vbatts (Vincent Batts)
Status: Open
Priority: Normal
Assignee: zzak (Zachary Scott)
Category: DOC
Target version: 2.0.0
ruby -v: ruby 2.0.0dev (2012-12-08) [i686-linux]


This fixes documentation in ENV, adds a little for debug.rb, and 
completes PP

Issue #7656 has been updated by zzak (Zachary Scott).

Status changed from Open to Feedback
Assignee changed from zzak (Zachary Scott) to vbatts (Vincent Batts)

Hello Vincent,

I've committed your patch for lib/debug. as r39019, I was reviewing your 
patch for lib/pp.rb and noticed the example for 
PPMethods::check_inspect_key doesn't work in trunk.

::check_inspect_key(obj.object_id) returns nil
then ::push_inspect_key(obj.object_id) raises: NoMethodError: undefined 
method `[]=' for nil:NilClass

----------------------------------------
Bug #7656: Handful of documentations
https://bugs.ruby-lang.org/issues/7656#change-35780

Author: vbatts (Vincent Batts)
Status: Feedback
Priority: Normal
Assignee: vbatts (Vincent Batts)
Category: DOC
Target version: 2.0.0
ruby -v: ruby 2.0.0dev (2012-12-08) [i686-linux]


This fixes documentation in ENV, adds a little for debug.rb, and 
completes PP

Issue #7656 has been updated by vbatts (Vincent Batts).


interesting, doing a little bootleg debugging
<patch>
diff --git a/lib/pp.rb b/lib/pp.rb
index 6e0c797..681956d 100644
--- a/lib/pp.rb
+++ b/lib/pp.rb
@@ -145,13 +145,16 @@ class PP < PrettyPrint
     def pp(obj)
       id = obj.object_id

+      puts check_inspect_key(id)
       if check_inspect_key(id)
         group {obj.pretty_print_cycle self}
         return
       end

       begin
-        push_inspect_key(id)
+        puts push_inspect_key(id)
+        puts check_inspect_key(id)
+        p Thread.current[:__recursive_key__][:inspect]
         group {obj.pretty_print self}
       ensure
         pop_inspect_key(id) unless PP.sharing_detection
</patch>

and running
<~/foo.rb>
class Foo
  def pretty_print(q)
    q.text 'foo'
  end
end

f = Foo.new
pp f
</~/foo.rb>

I get the following results:

vbatts@satellite ~/src/ruby (trunk) $ ruby -I./lib -r pp  ~/foo.rb
false
true
true
{67976200=>true, 67976030=>true}
foo


----------------------------------------
Bug #7656: Handful of documentations
https://bugs.ruby-lang.org/issues/7656#change-35842

Author: vbatts (Vincent Batts)
Status: Feedback
Priority: Normal
Assignee: vbatts (Vincent Batts)
Category: DOC
Target version: 2.0.0
ruby -v: ruby 2.0.0dev (2012-12-08) [i686-linux]


This fixes documentation in ENV, adds a little for debug.rb, and 
completes PP

Issue #7656 has been updated by vbatts (Vincent Batts).


I see, the example added to the methods is misleading. I'll revamp the 
docs for PP, and create a new issue.
----------------------------------------
Bug #7656: Handful of documentations
https://bugs.ruby-lang.org/issues/7656#change-35863

Author: vbatts (Vincent Batts)
Status: Feedback
Priority: Normal
Assignee: vbatts (Vincent Batts)
Category: DOC
Target version: 2.0.0
ruby -v: ruby 2.0.0dev (2012-12-08) [i686-linux]


This fixes documentation in ENV, adds a little for debug.rb, and 
completes PP

Issue #7656 has been updated by vbatts (Vincent Batts).

File ruby-docs_PrettyPrint-PP_20130206.patch added

Alrighty, since I don't have rights to close issues, I'll just add the 
updated PP/PrettyPrint patch here.
This patch fixes the confusing *_inspect_key example and also sets nodoc 
on the pretty print modifications to basic objects.
This patch also completes the documentation for PrettyPrint.
----------------------------------------
Bug #7656: Handful of documentations
https://bugs.ruby-lang.org/issues/7656#change-35965

Author: vbatts (Vincent Batts)
Status: Feedback
Priority: Normal
Assignee: vbatts (Vincent Batts)
Category: DOC
Target version: 2.0.0
ruby -v: ruby 2.0.0dev (2012-12-08) [i686-linux]


This fixes documentation in ENV, adds a little for debug.rb, and 
completes PP

Issue #7656 has been updated by zzak (Zachary Scott).

Status changed from Feedback to Assigned
Assignee changed from vbatts (Vincent Batts) to zzak (Zachary Scott)

Thanks Vincent! I will review this and commit tonight.
----------------------------------------
Bug #7656: Handful of documentations
https://bugs.ruby-lang.org/issues/7656#change-36020

Author: vbatts (Vincent Batts)
Status: Assigned
Priority: Normal
Assignee: zzak (Zachary Scott)
Category: DOC
Target version: 2.0.0
ruby -v: ruby 2.0.0dev (2012-12-08) [i686-linux]


This fixes documentation in ENV, adds a little for debug.rb, and 
completes PP