Bug #4710
closeddocumentation updates: Net::FTP is 100%
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) over 13 years ago
Can you separate documentation from whitespace diffs (and create a new issue)?
Updated by steveklabnik (Steve Klabnik) over 13 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) over 13 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.
Updated by vbatts (Vincent Batts) over 13 years ago
attached is the patch updated with no whitespace correction.
Updated by drbrain (Eric Hodel) over 13 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 13 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 mame@tsg.ne.jp
Updated by drbrain (Eric Hodel) about 13 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]