Project

General

Profile

Actions

Bug #4710

closed

documentation updates: Net::FTP is 100%

Added by vbatts (Vincent Batts) about 11 years ago. Updated about 11 years ago.

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

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 send_type_command(); 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


Files

Updated by drbrain (Eric Hodel) about 11 years ago

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

Updated by steveklabnik (Steve Klabnik) about 11 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.

Updated by drbrain (Eric Hodel) about 11 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 would clarify this.

Updated by vbatts (Vincent Batts) about 11 years ago

attached is the patch updated with no whitespace correction.

Actions #5

Updated by drbrain (Eric Hodel) about 11 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

Updated by mame (Yusuke Endoh) about 11 years ago

  • Status changed from Closed to Open

Hello,

I guess that Net::FTP#send_type_command 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

Actions #7

Updated by drbrain (Eric Hodel) about 11 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]
Actions

Also available in: Atom PDF