Bug #4710

documentation updates: Net::FTP is 100%

Added by Vincent Batts almost 3 years ago. Updated almost 3 years ago.

[ruby-core:<unknown>]
Status:Closed
Priority:Normal
Assignee:Eric Hodel
Category:doc
Target version:1.9.3
ruby -v:ruby 1.9.3dev (2011-05-16 trunk 31589) [x86_64-linux] Backport:

Description

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

This patch includes the following (and some cleanup of I into spaces)

class Net::FTP # is documented

# in file lib/net/ftp.rb
def binary=(newmode); end

# in file lib/net/ftp.rb
def getline(); end

# in file lib/net/ftp.rb
def getmultiline(); end

# in file lib/net/ftp.rb
def getresp(); end

# in file lib/net/ftp.rb
def makepasv(); end

# in file lib/net/ftp.rb
def makeport(); end

# in file lib/net/ftp.rb
def open_socket(host, port); end

# in file lib/net/ftp.rb
def parse227(resp); end

# in file lib/net/ftp.rb
def parse228(resp); end

# in file lib/net/ftp.rb
def parse229(resp); end

# in file lib/net/ftp.rb
def parse257(resp); end

# in file lib/net/ftp.rb
def putline(line); end

# in file lib/net/ftp.rb
def sanitize(s); end

# in file lib/net/ftp.rb
def sendtypecommand(); end

# in file lib/net/ftp.rb
def sendport(host, port); end

# in file lib/net/ftp.rb
def transfercmd(cmd, rest_offset = nil); end

# in file lib/net/ftp.rb
def voidresp(); end

# in file lib/net/ftp.rb
def with_binary(newmode); end

end

ruby_doc_updates-20110516_vbatts.patch Magnifier (20.8 KB) Vincent Batts, 05/16/2011 10:17 PM

ruby_doc_updates-20110517-0338_vbatts.patch Magnifier (5.37 KB) Vincent Batts, 05/17/2011 12:44 PM

Associated revisions

Revision 31616
Added by Eric Hodel almost 3 years ago

  • lib/net/ftp.rb: Improve documentation. Patch by Vincent Batts. [Ruby 1.9 - Bug #4710]
    • ChangeLog: commit miss

Revision 31727
Added by Eric Hodel almost 3 years ago

  • lib/net/ftp.rb: Add :nodoc: for private methods. [Ruby 1.9 - Bug #4710]

History

#1 Updated by Eric Hodel almost 3 years ago

Can you separate documentation from whitespace diffs (and create a new issue)?

#2 Updated by Steve Klabnik almost 3 years ago

Are whitespace-fixing diffs acceptable? If there's a standard of two spaces, I'll go ahead and make a big patch that just fixes all the whitespace.

#3 Updated by Eric Hodel almost 3 years ago

There has been a push to remove trailing whitespace from the repository, nobu performs periodic cleanup commits. I assume a tab -> spaces for .rb files cleanup would also be acceptable but I don't know, an email to ruby-core@ruby-lang.org would clarify this.

#4 Updated by Vincent Batts almost 3 years ago

attached is the patch updated with no whitespace correction.

#5 Updated by Eric Hodel almost 3 years ago

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

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


  • lib/net/ftp.rb: Improve documentation. Patch by Vincent Batts. [Ruby 1.9 - Bug #4710]
    • ChangeLog: commit miss

#6 Updated by Yusuke Endoh almost 3 years ago

  • Status changed from Closed to Open

Hello,

I guess that Net::FTP#sendtypecommand is not expected to be
used directly by user, and should be stated clearly.
Or please use :nodoc:.
The same goes for other private method in Net::FTP (sanitize,
putline, ...)

See #4694.

Yusuke Endoh mame@tsg.ne.jp

#7 Updated by Eric Hodel almost 3 years ago

  • Status changed from Open to Closed

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


  • lib/net/ftp.rb: Add :nodoc: for private methods. [Ruby 1.9 - Bug #4710]

Also available in: Atom PDF