http://blog.gmane.org/gmane.comp.lang.ruby.documentation hourly 1 1901-01-01T00:00+00:00 http://gmane.org/img/gmane-25t.png http://gmane.org http://comments.gmane.org/gmane.comp.lang.ruby.documentation/1068 Hello, "ri File" gives the documentation from lib/ftools.rb and not the intended description of the File class. ftools.rb has a declaration of the File class, which I suppose is not needed, so I removed it (attached patch). This fixes the documentation issues. All 1.8 branches are affected. trunk is not (ftools.rb was removed). Regards, Lars Lars Christensen 2008-09-14T09:31:58 http://comments.gmane.org/gmane.comp.lang.ruby.documentation/1062 unscribe Plain Wu 2008-07-14T04:07:16 http://comments.gmane.org/gmane.comp.lang.ruby.documentation/1043 unsubscribe jieer_lee 2008-07-09T01:55:13 http://comments.gmane.org/gmane.comp.lang.ruby.documentation/1039 unsubscribe -- 回头看看走过的路，再向前，你会走的更快。 jieer_lee 2008-07-07T07:57:10 http://comments.gmane.org/gmane.comp.lang.ruby.documentation/1035 Hello, I am ruby novice. And I am writing a free book on Ruby. And side by side making engaging elearning tutorials on it. I have already found an Instructional Designer as a mentor. I am looking for some guru on ruby who is willing to spare some time and help review the content so that its not technically wrong. Waiting for your reply. Regards, Befria AZ Befria 2008-07-03T18:51:40 http://comments.gmane.org/gmane.comp.lang.ruby.documentation/1031 Hi all, I am using the rdoc to document my ruby code. whcih has the xml files. While doing so I hitted this bug. I wanted to know whether there is any fix for it or a work around in rdoc to exclude the xml files while genrating the documentation. Help is appreciated. Thanks in advance Priya Ainapur Priya Ainapur 2008-06-30T13:07:40 http://comments.gmane.org/gmane.comp.lang.ruby.documentation/1026 Sorry for all the traffic on this list today, I went through trunk and found a large number of misspellings by using a script. Only about half of the files I changed exist on ruby 1_8_7, so I have attached a smaller diff for 1_8_7. CAVEAT: I edited all comments without discrimination, not specifically comments that are parsed by RDoc. If this is a problem I would be perfectly willing to eliminate everything but the documentation changes from my diff. I would like to thank Evan Weaver for the (updated) raspell library! Good Night Evan Farrar 2008-06-03T05:24:54 http://comments.gmane.org/gmane.comp.lang.ruby.documentation/1025 I was just reading the Telnet docs while coding this morning and got hung up by a typo. This patch can be applied equally in the 1.8.7 branch and trunk. Look forward to more of this now that I have gone through the submission guidelines and subbed to the mailing list. Cheers! Evan Farrar 2008-06-02T15:51:50 http://comments.gmane.org/gmane.comp.lang.ruby.documentation/1024 -----BEGIN PGP SIGNED MESSAGE----- Hash: SHA1 Hey, I've noticed a problem in the RDoc-generated HTML when a doc-modifier is used on a method without parentheses. I've attached a patch against SVN trunk that fixes this (though you may find a better way). I use :yields: in the following examples, but I've tried it with :notnew: and the same thing happened (and is fixed by my patch). Using this example with Ruby 1.9 (and 1.8): def hello # :yields: greetings yield "hello" end def helloparam(hi) # :yields: greetings yield hi end gives the following in the RDoc generated HTML: Public Instance methods hello( {|greetings| ...} helloparam(hi) {|greetings| ...} Notice the missing closing parentheses after hello? But after applying my patch, the parentheses is there: Public Instance methods hello() {|greetings| ...} helloparam(hi) {|greetings| ...} I've been showing helloparam() in these examples to show that it still works as expected on other methods. Thanks, Kris Katterjohn -----BEGIN PGP SIGNATURE----- Version: GnuPG v1.4.6 (GNU/Linux) Comment: Using GnuPG with Mozilla - http://enigmail.mozdev.org iQIVAwUBSBDC7P9K37xXYl36AQKVNQ/+I1hcu7rmPLnf6cMB2F7wNLZYonCDKrfL 9fEB1TxmX3o1lCENt3NhK+SLuvpzUj7Fe2dSCufHkrOpkw/hR6PtSzkRlQqybhHh QVyeSBvvLBpLQ0T6woUvVaeyInovowvAJ2IEVNgZeVIWUU5s+xbnfO8nwFZ/mc5l Px9eQKxnIdSPe9Ju14tGna/cqhkpc9CoMumWgt76vD7erZB/9eh0SPwxyqMvGz5D uc8NMeIZo1tjgqkg676FvriCSwgi1kzZjRMbYugEiRO+P0+DY/whV5cPqP6iqD8c AQ3g3ea4pakMLyz9GWVyH29zcEDGuNZ3Tl+4Ec2s334hEi2KZuWgO/ps+35e9TRK Sk9h9jKpQfDLfcxBw2kSX8aNg3Rt1lJ4QcGfrgF3abpz/v3buFOAd6BcI2LffiWs TwQt+n4SfO42c3oztfTaHVyPMo9GUKWcc4gbYPk7gatJt3ua2Es7r1sFdZc3v2+e emLJntTQmRXBQvkNIZoTLmOI0XeyKgHLcobyOG47mgdfpmI8L7h5SA3flH6dZXzD AYrbt/BQLYdUtDJoHc6u3uLNQB78/CL4TQaEtyn6mVe49xtxLecsDWgO1CY+x1Yj n7vQxFpnpuDrZ8YsdipVg1ialQhD6jWCMGQuslBaaSg3GgAXfSmx1xIRwJuecgct 1osywRiP5s4= =42c/ -----END PGP SIGNATURE----- Kris Katterjohn 2008-04-24T17:27:11 http://comments.gmane.org/gmane.comp.lang.ruby.documentation/1023 Hi guys, while the code posted below actually modifies the instance variable. There should imho be some kind of info in the Doc for attr_reader. Right now the doc reads: " attr(symbol, writable=false) => nil Defines a named attribute for this module, where the name is symbol.id2name, creating an instance variable (< at >name) and a corresponding access method to read it. If the optional writable argument is true, also creates a method called name= to set the attribute. " I would think that I am not the only one, new to the language drawing the wrong conclusion that setting writable to false actually makes the instance variable not writable. Or am I of the field here ? Regards Oliver class AttrReaderErr attr_reader :entries def initialize() < at >entries = [0,1,2] end end showcase = AttrReaderErr.new puts showcase.entries #should this really work ? showcase.entries[1]="foo" puts "\n" #it does, but looks wrong to me puts showcase.entries Hexren 2008-04-09T19:33:12 http://comments.gmane.org/gmane.comp.lang.ruby.documentation/1011 I'm trying to compile Ruby 1.9 on my web hosting provider's box running Fedora Core 4. It compiles just fine, but when I do "make install" and try to generate the docs, it chokes. Here is the error message: --------------------------------------------------------------------------------------------------------------------- No definition for rb_fiber_m_transfer .. No definition for rb_fiber_alive_p .. No definition for rb_fiber_s_current .. file.c: mcmc...................................................................................................................................... vm_dump.c: eval_safe.c: time.c: c.........................................../home/maksim/ruby-1.9.0-0/lib/rdoc/parsers/parse_c.rb:630:in `find_body': unmatched close parenthesis: /((?>\/\*.*?\*\/\s*))(?:static\s+)?VALUE\s+time_utc_offset (RegexpError) \s*(\([^)]*\))\s*\{.*?^\}/mx from /home/maksim/ruby-1.9.0-0/lib/rdoc/parsers/parse_c.rb:619:in `handle_method' from /home/maksim/ruby-1.9.0-0/lib/rdoc/parsers/parse_c.rb:415:in `block in do_methods' from /home/maksim/ruby-1.9.0-0/lib/rdoc/parsers/parse_c.rb:392:in `scan' from /home/maksim/ruby-1.9.0-0/lib/rdoc/parsers/parse_c.rb:392:in `do_methods' from /home/maksim/ruby-1.9.0-0/lib/rdoc/parsers/parse_c.rb:195:in `scan' from /home/maksim/ruby-1.9.0-0/lib/rdoc/rdoc.rb:231:in `block in parse_files' from /home/maksim/ruby-1.9.0-0/lib/rdoc/rdoc.rb:219:in `each' from /home/maksim/ruby-1.9.0-0/lib/rdoc/rdoc.rb:219:in `parse_files' from /home/maksim/ruby-1.9.0-0/lib/rdoc/rdoc.rb:269:in `document' from ./bin/rdoc:63:in `<main>' make: *** [rdoc] Error 1 [2] openhost:~/ruby-1.9.0-0 --------------------------------------------------------------------------------------------------------------------- which shows that the culprit is time.c file. The funny thing is that generating docs for just this file by itself works OK: ---------------------------------------------------------------------------------------------------------------------- [1] openhost:~/ruby-1.9.0-0 $ ./miniruby ./runruby.rb --extout=.ext -- "./bin/rdoc" --all --ri --op ".ext/rdoc2" time.c time.c: c.............................................................. Generating RI... Files: 1 Classes: 1 Modules: 0 Methods: 62 Elapsed: 0.526s [0] openhost:~/ruby-1.9.0-0 $ ------------------------------------------------------------------------------------------------------------------ At home, on Fedora 8 box everything works fine. Any help, please? Thank you. Max --------------------------------- Be a better friend, newshound, and know-it-all with Yahoo! Mobile. Try it now. Maksim Khrapov 2008-01-21T19:54:44 http://comments.gmane.org/gmane.comp.lang.ruby.documentation/1009 confirm 2007122816054812061063720645 gs techie ____________________________________________________________________________________ Looking for last minute shopping deals? Find them fast with Yahoo! Search. http://tools.search.yahoo.com/newsearch/category.php?category=shopping Gs Techie 2007-12-29T04:56:11 http://comments.gmane.org/gmane.comp.lang.ruby.documentation/1008 I've finally transferred the RubySpec wiki to a server hosted under the ruby-doc "spec" subdomain. http://spec.ruby-doc.org/wiki (spec.ruby-doc.org redirects here, since in the future there may be other things we'd like to host under this domain) Any links on the main ruby-doc site that are pointing at headius.com should be updated to appropriate locations under the new address. headius.com/rubyspec/* are all set to redirect to the spec.ruby-doc.org site. - Charlie Charles Oliver Nutter 2007-11-20T01:15:38 http://comments.gmane.org/gmane.comp.lang.ruby.documentation/1006 Hi guys, I'm new on documenting Ruby sources, I have some early opinions about RDoc but this time and want to ask you something. I tried to wrap code examples in comments using the following: # <tt> # def setUp # files << File.new() # end # </tt> But it doesn't work, it generates an ugly HTML like <tt> def setUp < at >appStates << AppState1.new() end </tt> What am I missing here? Thanks, Ubaldo Ubaldo Villaseca 2007-11-12T23:07:21 http://comments.gmane.org/gmane.comp.lang.ruby.documentation/1005 I'm trying to get the names of people who have been contributing rdoc content to Ruby's standard library. If you have you contributed such documentation, please E-mail me off-list. I would like to know what you have documented, and when. I'm pursuing a project concerning the current Ruby std-lib docs, and may need to be in touch with you. Thanks, James Britt james.britt< at >gmail.com http://www.ruby-doc.org James Britt 2007-11-11T03:13:55 http://comments.gmane.org/gmane.comp.lang.ruby.documentation/1003 Hi all! I submitted the following to http://rubyforge.org/tracker/index.php?func=detail&aid=14051 &group_id=426&atid=1700 Numeric#divmod (numeric.c line 264-302) ======================================== 1. There is an error in the table in column a/b: 13/-4 is -4, not -3! C:\Dokume~1\All Users\Dokume~1>irb irb(main):001:0> RUBY_VERSION #=> "1.8.6" irb(main):002:0> 13/-4 #=> -4 <=! 2. The divmod formula a. is given in C and not Ruby terms, b. should use the same parameter names as the table and c. is wrong: Numeric does not convert a and b to floats. The division with "/" is handled by the respective subclasses and they do it differently depending on the class of num. So, it would be correct and Ruby-esk to write: * Returns an array containing the quotient and modulus obtained by * dividing <i>num</i> by <i>aNumeric</i>. * If * q, r = a.divmod(b) * then * q = (a/b).floor * r = a.modulo(b) = a - q*b 3. For didactical reasons I would also propose to change the table layout: * | a.divmod(b) | * a | b | a/b | (a/b).floor, a.modulo(b) | a.remainder(b) * ------+-----+--------+---------------------------+--------------- * 13 | 4 | 3 | 3 , 1 | 1 * ------+-----+--------+---------------------------+--------------- * 13 | -4 | -4 | -4 , -3 | 1 * ------+-----+--------+---------------------------+--------------- instead of * a | b | a.divmod(b) | a/b | a.modulo(b) | a.remainder(b) * ------+-----+---------------+---------+-------------+--------------- * 13 | 4 | 3, 1 | 3 | 1 | 1 * ------+-----+---------------+---------+-------------+--------------- * 13 | -4 | -4, -3 | -3 | -3 | 1 * ------+-----+---------------+---------+-------------+--------------- Altogether my corrections and proposals sum up to: -------------------------------------------------------------------------- /* * call-seq: * num.divmod( aNumeric ) => anArray * * Returns an array containing the quotient and modulus obtained by * dividing <i>num</i> by <i>aNumeric</i>. * If * q, r = a.divmod(b) * then * q = (a/b).floor * r = a.modulo(b) = a - q*b * * The quotient is rounded toward -infinity, as shown in the following table: * * | a.divmod(b) | * a | b | a/b | (a/b).floor, a.modulo(b) | a.remainder(b) * ------+-----+--------+---------------------------+--------------- * 13 | 4 | 3 | 3 , 1 | 1 * ------+-----+--------+---------------------------+--------------- * 13 | -4 | -4 | -4 , -3 | 1 * ------+-----+--------+---------------------------+--------------- * -13 | 4 | -4 | -4 , 3 | -1 * ------+-----+--------+---------------------------+--------------- * -13 | -4 | 3 | 3 , -1 | -1 * ------+-----+--------+---------------------------+--------------- * 11.5 | 4 | 2.875 | 2 , 3.5 | 3.5 * ------+-----+--------+---------------------------+--------------- * 11.5 | -4 | -2.875 | -3 , -0.5 | 3.5 * ------+-----+--------+---------------------------+--------------- * -11.5 | 4 | -2.875 | -3 , 0.5 | -3.5 * ------+-----+--------+---------------------------+--------------- * -11.5 | -4 | 2.875 | 2 , -3.5 | -3.5 * * * Examples * 11.divmod(3) #=> [3, 2] * 11.divmod(-3) #=> [-4, -1] * 11.divmod(3.5) #=> [3, 0.5] * (-11.5).divmod(3.5) #=> [-4, 2.5] * Rational(7,4).divmod Rational(1,2) #=> [3, Rational(1,4)] */ -------------------------------------------------------------------------- instead of the old: -------------------------------------------------------------------------- /* * call-seq: * num.divmod( aNumeric ) -> anArray * * Returns an array containing the quotient and modulus obtained by * dividing <i>num</i> by <i>aNumeric</i>. If <code>q, r = * x.divmod(y)</code>, then * * q = floor(float(x)/float(y)) * x = q*y + r * * The quotient is rounded toward -infinity, as shown in the following table: * * a | b | a.divmod(b) | a/b | a.modulo(b) | a.remainder(b) * ------+-----+---------------+---------+-------------+--------------- * 13 | 4 | 3, 1 | 3 | 1 | 1 * ------+-----+---------------+---------+-------------+--------------- * 13 | -4 | -4, -3 | -3 | -3 | 1 * ------+-----+---------------+---------+-------------+--------------- * -13 | 4 | -4, 3 | -4 | 3 | -1 * ------+-----+---------------+---------+-------------+--------------- * -13 | -4 | 3, -1 | 3 | -1 | -1 * ------+-----+---------------+---------+-------------+--------------- * 11.5 | 4 | 2, 3.5 | 2.875 | 3.5 | 3.5 * ------+-----+---------------+---------+-------------+--------------- * 11.5 | -4 | -3, -0.5 | -2.875 | -0.5 | 3.5 * ------+-----+---------------+---------+-------------+--------------- * -11.5 | 4 | -3, 0.5 | -2.875 | 0.5 | -3.5 * ------+-----+---------------+---------+-------------+--------------- * -11.5 | -4 | 2, -3.5 | 2.875 | -3.5 | -3.5 * * * Examples * 11.divmod(3) #=> [3, 2] * 11.divmod(-3) #=> [-4, -1] * 11.divmod(3.5) #=> [3, 0.5] * (-11).divmod(3.5) #=> [-4, 3.0] * (11.5).divmod(3.5) #=> [3, 1.0] */ -------------------------------------------------------------------------- The patch to numeric.c is attached. Regards, Dirk Dirk Traulsen 2007-09-18T19:48:58 http://comments.gmane.org/gmane.comp.lang.ruby.documentation/1002 I'm investigating why I can't get any useful rdoc output for the HTTPClient library. (http://dev.ctor.org/http-access2) I've created a test case that illustrates the problem I've found. It appears that the rdoc program ignores documented methods when there is multiple-line constant definitions in the source-file. With the attached test case, if I run rdoc on it as-is, I get no HTML documentation for the initialize() and get_content() functions. However, if I remove the SSLEnabled and SSPIEnabled definitions, then rdoc will generate HTML documentation for initialize() and get_content(). Can anyone confirm this behavior? Is this a bug in rdoc? Or is there something wrong with the HTTPClient code? class HTTPClient SSLEnabled = begin require 'openssl' true rescue LoadError false end SSPIEnabled = begin require 'win32/sspi' true rescue LoadError false end # SYNOPSIS # Client.new(proxy = nil, agent_name = nil, from = nil) def initialize(proxy = nil, agent_name = nil, from = nil) < at >proxy = nil end # SYNOPSIS # Client#get_content(uri, query = nil, extheader = {}, &block = nil) def get_content(uri, query = nil, extheader = {}, &block) 'no content' end end Brian Sammon 2007-09-16T04:59:03 http://comments.gmane.org/gmane.comp.lang.ruby.documentation/997 One of the sources of information on Ruby that has a lot of accumulated knowledge is the Ruby Garden Wiki. However, I have reached the point where I consider it broken beyond repair. The amount of Wiki spam was bad enough, but at least I could mark that as being posted by spammers and this seemed to stem the tide a bit. Now I've just looked and there are loads of completely spurious pages created, like Rb_P, most of which claim to have no revision 1. I can't get rid of them. Maybe, even as a person who can approve postings, I don't have enough privileges to do so. So should we just make it read-only now? Requiring that users have an account is no use unless we are stringent about who we accept as having an account. Otherwise we'll get the "spam from temporary email address" problem replicated. Is there anything else we could do? Hugh Hugh Sasse 2007-09-07T11:08:02 http://comments.gmane.org/gmane.comp.lang.ruby.documentation/996 All, I've attached a patch for the documentation for Struct::new. The second edition of The Pickaxe Book says: It turns out that this functionality has actually been present since 1.8.3! This is the relevant ChangeLog entry: http://svn.ruby-lang.org/cgi-bin/viewvc.cgi/trunk/struct.c?view=log#rev5934 (although it references [ruby-talk:02606], it should really be [ruby-core:02606]: http://blade.nagaokaut.ac.jp/cgi-bin/scat.rb/ruby/ruby-core/2606 I've tried to stick to the submission guidelines, but please let me know if I've screwed anything up! Cheers, ------------------------------------------------ Paul Butcher CTO Texperts Mobile: +44 (0) 7740 857648 Main: +44 (0) 1223 309080 Fax: +44(0) 1223 309082 Email: paul< at >texperts.com MSN: paul< at >paulbutcher.com AIM: paulrabutcher Skype: paulrabutcher LinkedIn: http://www.linkedin.com/in/paulbutcher ------------------------------------------------ Re5ult Limited Registered in England No 04909795 VAT registration number GB 849 201 231. Registered office 22 Great James Street Londong WC1N 3ES This email is confidential. It may be read, copied and used only by the intended recipient. If you have received it in error, please contact us immediately. Paul Butcher 2007-09-03T20:20:48 http://comments.gmane.org/gmane.comp.lang.ruby.documentation/995 Hello, The default arguments of exit and exit! are 0 and 1 in rdoc, but I think there are true and false now. Kazuhiro NISHIYAMA 2007-08-15T20:13:39 http://comments.gmane.org/gmane.comp.lang.ruby.documentation/985 Tim Harper 2007-08-03T02:30:00 Search the mailing list at Gmane query http://search.gmane.org/?group=$group=gmane.comp.lang.ruby.documentation