diff scripts/@ftp/ascii.m @ 14217:7912e682aa30

doc: Update docstrings for @ftp class. * aspell-octave.en.pws: Add new functions to spellchecker. * system.txi: Add DOCSTRING entries for all @ftp functions * ascii.m, binary.m, cd.m, close.m, delete.m, dir.m, ftp.m, loadobj.m, mget.m, mkdir.m, mput.m, rename.m, rmdir.m: Update docstrings.
author Rik <octave@nomad.inbox5.com>
date Wed, 18 Jan 2012 21:15:50 -0800
parents 72c96de7a403
children 1c89599167a6
line wrap: on
line diff
--- a/scripts/@ftp/ascii.m
+++ b/scripts/@ftp/ascii.m
@@ -18,7 +18,11 @@
 
 ## -*- texinfo -*-
 ## @deftypefn {Function File} {} ascii (@var{f})
-## Put the FTP connection @var{f} into ascii mode.
+## Set the FTP connection @var{f} to use ASCII mode for transfers.
+## ASCII mode is only appropriate for text files as it will convert
+## the remote host's newline representation to the local host's newline
+## representation.
+##
 ## @var{f} is an FTP object returned by the @code{ftp} function.
 ## @end deftypefn