Project

General

Profile

Bug #4711

documentation updates: Net::POP3 and Net::Telnet are 100%

Added by vbatts (Vincent Batts) over 6 years ago. Updated over 6 years ago.

Status:
Closed
Priority:
Normal
Target version:
ruby -v:
ruby 1.9.3dev (2011-05-16 trunk 31589) [x86_64-linux]
[ruby-core:36227]

Description

per http://blog.segment7.net/2011/05/09/ruby-1-9-3-documentation-challenge

This patch includes the following bits.

class Net::Telnet # is documented

# in file lib/net/telnet.rb
def close(); end

end

class Net::POP3 # is documented

# in file lib/net/pop.rb
Revision = nil
# in file lib/net/pop.rb
def certs(); end

# in file lib/net/pop.rb
def create_ssl_params(verify_or_params = {}, certs = nil); end

# in file lib/net/pop.rb
def ssl_params(); end

# in file lib/net/pop.rb
def use_ssl?(); end

# in file lib/net/pop.rb
def verify(); end

# in file lib/net/pop.rb
def command(); end

# in file lib/net/pop.rb
def disable_ssl(); end

# in file lib/net/pop.rb
def do_finish(); end

# in file lib/net/pop.rb
def do_start(account, password); end

# in file lib/net/pop.rb
def logging(msg); end

# in file lib/net/pop.rb
def on_connect(); end

end

Associated revisions

Revision 31602
Added by drbrain (Eric Hodel) over 6 years ago

  • lib/net/pop.rb: Improve documentation. Patch by Vincent Batts. [Ruby 1.9 - Bug #4711]
    • lib/net/telnet.rb: ditto

Revision 31602
Added by drbrain (Eric Hodel) over 6 years ago

  • lib/net/pop.rb: Improve documentation. Patch by Vincent Batts. [Ruby 1.9 - Bug #4711]
    • lib/net/telnet.rb: ditto

Revision 31602
Added by drbrain (Eric Hodel) over 6 years ago

  • lib/net/pop.rb: Improve documentation. Patch by Vincent Batts. [Ruby 1.9 - Bug #4711]
    • lib/net/telnet.rb: ditto

Revision 31602
Added by drbrain (Eric Hodel) over 6 years ago

  • lib/net/pop.rb: Improve documentation. Patch by Vincent Batts. [Ruby 1.9 - Bug #4711]
    • lib/net/telnet.rb: ditto

Revision 31728
Added by drbrain (Eric Hodel) over 6 years ago

  • lib/net/pop.rb: Hide implementation details from RDoc. [Ruby 1.9 - Bug #4711]

Revision 31728
Added by drbrain (Eric Hodel) over 6 years ago

  • lib/net/pop.rb: Hide implementation details from RDoc. [Ruby 1.9 - Bug #4711]

Revision 31728
Added by drbrain (Eric Hodel) over 6 years ago

  • lib/net/pop.rb: Hide implementation details from RDoc. [Ruby 1.9 - Bug #4711]

Revision 31728
Added by drbrain (Eric Hodel) over 6 years ago

  • lib/net/pop.rb: Hide implementation details from RDoc. [Ruby 1.9 - Bug #4711]

History

#1 [ruby-core:36236] Updated by vbatts (Vincent Batts) over 6 years ago

meh, i missed a single line comment for def disable_ssl(); end

see the attached updated patch

#2 Updated by drbrain (Eric Hodel) over 6 years ago

  • Status changed from Open to Closed
  • % Done changed from 0 to 100

This issue was solved with changeset r31602.
Vincent, thank you for reporting this issue.
Your contribution to Ruby is greatly appreciated.
May Ruby be with you.


  • lib/net/pop.rb: Improve documentation. Patch by Vincent Batts. [Ruby 1.9 - Bug #4711]
    • lib/net/telnet.rb: ditto

#3 [ruby-core:36422] Updated by mame (Yusuke Endoh) over 6 years ago

  • Status changed from Closed to Open

Hello,

  • # internal method for Net::POP3.start
    def do_start(account, password)

  • # Does nothing
    def on_connect
    end
    private :on_connect

  • # nil's out the:

  • # - mails

  • # - number counter for mails

  • # - number counter for bytes

  • # - quits the current command, if any
    def do_finish

Is any comment needed there?
If so, they should be more verbose.
I think that :nodoc: is a good idea here.

--
Yusuke Endoh mame@tsg.ne.jp

#4 Updated by drbrain (Eric Hodel) over 6 years ago

  • Status changed from Open to Closed

This issue was solved with changeset r31728.
Vincent, thank you for reporting this issue.
Your contribution to Ruby is greatly appreciated.
May Ruby be with you.


  • lib/net/pop.rb: Hide implementation details from RDoc. [Ruby 1.9 - Bug #4711]

#5 [ruby-core:36445] Updated by drbrain (Eric Hodel) over 6 years ago

What is the on_connect method for? Net::HTTP has an empty on_connect method also, is it for subclasses of Net::HTTP and Net::POP3?

#6 [ruby-core:36452] Updated by usa (Usaku NAKAMURA) over 6 years ago

What is the on_connect method for? Net::HTTP has an empty on_connect method also, is it for subclasses of Net::HTTP and Net::POP3?

I guess so.

Also available in: Atom PDF