Forum: Ruby-core [ruby-trunk - Bug #6929][Open] Documentation for Ripper

Posted by zzak (Zachary Scott) (Guest)
on 2012-08-27 14:01
(Received via mailing list)
Issue #6929 has been reported by zzak (Zachary Scott).

----------------------------------------
Bug #6929: Documentation for Ripper
https://bugs.ruby-lang.org/issues/6929

Author: zzak (Zachary Scott)
Status: Open
Priority: Normal
Assignee: drbrain (Eric Hodel)
Category: DOC
Target version: 2.0.0
ruby -v: 2.0.0


I've added a patch to improve the documentation for the standard library 
Ripper.

As always, feedback welcome.
Posted by drbrain (Eric Hodel) (Guest)
on 2012-08-29 04:17
(Received via mailing list)
Issue #6929 has been updated by drbrain (Eric Hodel).


I think this is good overall.

No change should be necessary for extconf.rb or ext/ripper/tools as they 
are not included in ext/.document, can you check it?

----------------------------------------
Bug #6929: Documentation for Ripper
https://bugs.ruby-lang.org/issues/6929#change-29091

Author: zzak (Zachary Scott)
Status: Open
Priority: Normal
Assignee: drbrain (Eric Hodel)
Category: DOC
Target version: 2.0.0
ruby -v: 2.0.0


I've added a patch to improve the documentation for the standard library 
Ripper.

As always, feedback welcome.
Posted by zzak (Zachary Scott) (Guest)
on 2012-08-29 14:10
(Received via mailing list)
Issue #6929 has been updated by zzak (Zachary Scott).


ext/.document only lists ripper/lib and ripper/ripper.c (which doesn't 
exist)

I only added :nodoc: to ripper/tools and ripper/extconf.rb because those 
methods were showing up in documentation coverage report. I'm not sure 
how to use ext/.document with rdoc options, could you explain?

I'll put together another patch without the ripper/extconf.rb and 
ripper/tools stuff.

Thanks Eric!
----------------------------------------
Bug #6929: Documentation for Ripper
https://bugs.ruby-lang.org/issues/6929#change-29095

Author: zzak (Zachary Scott)
Status: Open
Priority: Normal
Assignee: drbrain (Eric Hodel)
Category: DOC
Target version: 2.0.0
ruby -v: 2.0.0


I've added a patch to improve the documentation for the standard library 
Ripper.

As always, feedback welcome.
Posted by drbrain (Eric Hodel) (Guest)
on 2012-08-29 23:14
(Received via mailing list)
Issue #6929 has been updated by drbrain (Eric Hodel).


=begin
When ((%make rdoc%)) runs it starts at the root and looks for 
".document" files in the current directory.  These files contain the 
paths that RDoc is allowed to traverse.  Subdirectories may contain 
.document files, and ext/.document contains paths for ripper which 
expand to "ext/ripper/ripper.c" and "ext/ripper/lib".

If you run RDoc by hand you need to take into account the contents of 
the .document file.  If you have:

  rdoc ext/ripper

RDoc won't look in ext/.document or .document to determine which paths 
it should exclude or include.  You need to run:

  rdoc ext/ripper/ripper.c ext/ripper/lib

PS: Perhaps looking for .document files between the current directory 
and the source directory should be an option in RDoc
=end

----------------------------------------
Bug #6929: Documentation for Ripper
https://bugs.ruby-lang.org/issues/6929#change-29099

Author: zzak (Zachary Scott)
Status: Open
Priority: Normal
Assignee: drbrain (Eric Hodel)
Category: DOC
Target version: 2.0.0
ruby -v: 2.0.0


I've added a patch to improve the documentation for the standard library 
Ripper.

As always, feedback welcome.
Posted by zzak (Zachary Scott) (Guest)
on 2012-08-30 22:36
(Received via mailing list)
Issue #6929 has been updated by zzak (Zachary Scott).

File 0002-Documentation-for-Ripper.patch added

Hi Eric!

Thanks for your feedback, I've added a patch sans the ripper/extconf.rb 
and ripper/tools changes as 0002-*
----------------------------------------
Bug #6929: Documentation for Ripper
https://bugs.ruby-lang.org/issues/6929#change-29111

Author: zzak (Zachary Scott)
Status: Open
Priority: Normal
Assignee: drbrain (Eric Hodel)
Category: DOC
Target version: 2.0.0
ruby -v: 2.0.0


I've added a patch to improve the documentation for the standard library 
Ripper.

As always, feedback welcome.
Posted by drbrain (Eric Hodel) (Guest)
on 2012-08-30 22:56
(Received via mailing list)
Issue #6929 has been updated by drbrain (Eric Hodel).


This looks good, please commit it.
----------------------------------------
Bug #6929: Documentation for Ripper
https://bugs.ruby-lang.org/issues/6929#change-29113

Author: zzak (Zachary Scott)
Status: Open
Priority: Normal
Assignee: drbrain (Eric Hodel)
Category: DOC
Target version: 2.0.0
ruby -v: 2.0.0


I've added a patch to improve the documentation for the standard library 
Ripper.

As always, feedback welcome.
Posted by drbrain (Eric Hodel) (Guest)
on 2012-09-05 20:14
(Received via mailing list)
Issue #6929 has been updated by drbrain (Eric Hodel).

Assignee changed from drbrain (Eric Hodel) to zzak (Zachary Scott)


----------------------------------------
Bug #6929: Documentation for Ripper
https://bugs.ruby-lang.org/issues/6929#change-29196

Author: zzak (Zachary Scott)
Status: Open
Priority: Normal
Assignee: zzak (Zachary Scott)
Category: DOC
Target version: 2.0.0
ruby -v: 2.0.0


I've added a patch to improve the documentation for the standard library 
Ripper.

As always, feedback welcome.
Posted by Eregon (Benoit Daloze) (Guest)
on 2012-09-13 12:56
(Received via mailing list)
Issue #6929 has been updated by Eregon (Benoit Daloze).


zzak: Good work!

Just a little note, when you say:
"# In our case, we're simply returning a String, so next we have the
 # +:void_stmt+ followed by a +:string_literal+."

The :void_stmt seems to be due only to the extra ";" in the code string.
Using 'def hello(world) "Hello, #{world}!"; end' won't produce the 
:void_stmt,
which I think is more of a parser artifact than it is meaningful in this 
context.

----------------------------------------
Bug #6929: Documentation for Ripper
https://bugs.ruby-lang.org/issues/6929#change-29276

Author: zzak (Zachary Scott)
Status: Closed
Priority: Normal
Assignee: zzak (Zachary Scott)
Category: DOC
Target version: 2.0.0
ruby -v: 2.0.0


I've added a patch to improve the documentation for the standard library 
Ripper.

As always, feedback welcome.
Posted by zzak (Zachary Scott) (Guest)
on 2012-09-13 15:27
(Received via mailing list)
Issue #6929 has been updated by zzak (Zachary Scott).


=begin
Eregon: Thank you for the feedback! Would you prefer the following 
instead?

(({# In our case, we're simply returning a String, so next we have the 
+:string_literal+ expression.}))

Then just leave out the extra semicolon from the example and 
explanation.
=end
----------------------------------------
Bug #6929: Documentation for Ripper
https://bugs.ruby-lang.org/issues/6929#change-29280

Author: zzak (Zachary Scott)
Status: Closed
Priority: Normal
Assignee: zzak (Zachary Scott)
Category: DOC
Target version: 2.0.0
ruby -v: 2.0.0


I've added a patch to improve the documentation for the standard library 
Ripper.

As always, feedback welcome.
Posted by Eregon (Benoit Daloze) (Guest)
on 2012-09-13 16:22
(Received via mailing list)
Issue #6929 has been updated by Eregon (Benoit Daloze).


Yes, that sounds good.
----------------------------------------
Bug #6929: Documentation for Ripper
https://bugs.ruby-lang.org/issues/6929#change-29282

Author: zzak (Zachary Scott)
Status: Closed
Priority: Normal
Assignee: zzak (Zachary Scott)
Category: DOC
Target version: 2.0.0
ruby -v: 2.0.0


I've added a patch to improve the documentation for the standard library 
Ripper.

As always, feedback welcome.
Posted by Zachary Scott (Guest)
on 2012-09-13 16:33
(Received via mailing list)
Should I setup a new ticket for this?

On Thu, Sep 13, 2012 at 10:21 AM, Eregon (Benoit Daloze)
Posted by Eregon (Benoit Daloze) (Guest)
on 2012-09-13 20:25
(Received via mailing list)
Issue #6929 has been updated by Eregon (Benoit Daloze).


zzak (Zachary Scott) wrote:
> Should I setup a new ticket for this?

I would say go ahead and commit it, as it's just a related and small 
fix.
It would be a nice to have drbrain's opinion, but I think we all agree 
for this.
----------------------------------------
Bug #6929: Documentation for Ripper
https://bugs.ruby-lang.org/issues/6929#change-29287

Author: zzak (Zachary Scott)
Status: Closed
Priority: Normal
Assignee: zzak (Zachary Scott)
Category: DOC
Target version: 2.0.0
ruby -v: 2.0.0


I've added a patch to improve the documentation for the standard library 
Ripper.

As always, feedback welcome.
Posted by Zachary Scott (Guest)
on 2012-09-13 20:28
(Received via mailing list)
Hello,

On Thu, Sep 13, 2012 at 2:25 PM, Eregon (Benoit Daloze)
<redmine@ruby-lang.org> wrote:
> I would say go ahead and commit it, as it's just a related and small fix.
> It would be a nice to have drbrain's opinion, but I think we all agree for this.

If there's no objection after a while I will commit it.


Thank you
Posted by drbrain (Eric Hodel) (Guest)
on 2012-09-14 02:24
(Received via mailing list)
Issue #6929 has been updated by drbrain (Eric Hodel).


As a documentation committer, feel free to commit documentation without 
making tickets unless you would like to get a review. I think you should 
commit this change.
----------------------------------------
Bug #6929: Documentation for Ripper
https://bugs.ruby-lang.org/issues/6929#change-29294

Author: zzak (Zachary Scott)
Status: Closed
Priority: Normal
Assignee: zzak (Zachary Scott)
Category: DOC
Target version: 2.0.0
ruby -v: 2.0.0


I've added a patch to improve the documentation for the standard library 
Ripper.

As always, feedback welcome.
Posted by nagachika (Tomoyuki Chikanaga) (Guest)
on 2012-09-20 17:46
(Received via mailing list)
Issue #6929 has been updated by nagachika (Tomoyuki Chikanaga).


Hello,

In r36992, sample output from Ripper.sexp seems not from current trunk 
version. doesn't it?

-#             [:params, [[:@ident, "world", [1, 10]]], nil, nil, nil, 
nil]],
+#             [:params, [[:@ident, "world", [1, 10]]], nil, nil, nil, 
nil, nil, nil]],

----------------------------------------
Bug #6929: Documentation for Ripper
https://bugs.ruby-lang.org/issues/6929#change-29626

Author: zzak (Zachary Scott)
Status: Closed
Priority: Normal
Assignee: zzak (Zachary Scott)
Category: DOC
Target version: 2.0.0
ruby -v: 2.0.0


I've added a patch to improve the documentation for the standard library 
Ripper.

As always, feedback welcome.
Posted by zzak (Zachary Scott) (Guest)
on 2012-09-20 18:01
(Received via mailing list)
Issue #6929 has been updated by zzak (Zachary Scott).


nagachika: That is correct. I just tried again on ruby-trunk, there are 
6 +nil+s
----------------------------------------
Bug #6929: Documentation for Ripper
https://bugs.ruby-lang.org/issues/6929#change-29627

Author: zzak (Zachary Scott)
Status: Closed
Priority: Normal
Assignee: zzak (Zachary Scott)
Category: DOC
Target version: 2.0.0
ruby -v: 2.0.0


I've added a patch to improve the documentation for the standard library 
Ripper.

As always, feedback welcome.
Please log in before posting. Registration is free and takes only a minute.
Existing account (Switch to SSL-encrypted connection)
NEW: Do you have a Google/GoogleMail or Yahoo account? No registration required!
Log in with Google account | Log in with Yahoo account
No account? Register here.