Mercurial > octave-nkf
changeset 18891:7bbe3658c5ef
maint: Use "FIXME:" coding convention in m-files.
* flipdim.m, prepad.m, rotdim.m, doc.m, strread.m, textread.m, krylov.m,
colon.m, dump_prefs.m, fileattrib.m, getappdata.m, __xzip__.m, unpack.m,
fsolve.m, axis.m, meshc.m, print.m, __ghostscript__.m, __go_draw_axes__.m,
__print_parse_opts__.m, struct2hdl.m, unique.m, spstats.m, treeplot.m, test.m,
datestr.m: Use "FIXME:" coding convention in m-files.
line wrap: on
line diff
--- a/scripts/general/flipdim.m Wed Jun 25 12:51:55 2014 -0700 +++ b/scripts/general/flipdim.m Wed Jun 25 13:45:41 2014 -0700 @@ -62,7 +62,7 @@ %!assert (flipdim ([1,2;3,4], 2), [2,1;4,3]) %!assert (flipdim ([1,2;3,4], 3), [1,2;3,4]) -## FIXME -- we need tests for multidimensional arrays. +## FIXME: We need tests for multidimensional arrays. %!error flipdim () %!error flipdim (1, 2, 3)
--- a/scripts/general/prepad.m Wed Jun 25 12:51:55 2014 -0700 +++ b/scripts/general/prepad.m Wed Jun 25 13:45:41 2014 -0700 @@ -97,7 +97,7 @@ %!assert (prepad ([1,2], 2, 2, 3), reshape ([2,2,1,2], 1, 2, 2)) %!assert (prepad ([1;2], 2, 2, 3), reshape ([2;2;1;2], 2, 1, 2)) -## FIXME -- we need tests for multidimensional arrays. +## FIXME: We need tests for multidimensional arrays. %!error prepad () %!error prepad (1)
--- a/scripts/general/rotdim.m Wed Jun 25 12:51:55 2014 -0700 +++ b/scripts/general/rotdim.m Wed Jun 25 13:45:41 2014 -0700 @@ -152,8 +152,8 @@ %!assert (rotdim (m, 3), rotdim (m, -1)) %!assert (rotdim (m, 1), rotdim (m)) -## FIXME -- we need tests for multidimensional arrays and different -## values of PLANE. +## FIXME: We need tests for multidimensional arrays +## and different values of PLANE. %!error rotdim () %!error rotdim (1, 2, 3, 4)
--- a/scripts/help/doc.m Wed Jun 25 12:51:55 2014 -0700 +++ b/scripts/help/doc.m Wed Jun 25 13:45:41 2014 -0700 @@ -42,7 +42,7 @@ if (nargin == 1) ## Get the directory where the function lives. - ## FIXME -- maybe we should have a better way of doing this. + ## FIXME: Maybe we should have a better way of doing this? if (ischar (fname)) ftype = exist (fname); @@ -86,7 +86,7 @@ endif endif - ## FIXME -- don't change the order of the arguments below because + ## FIXME: Don't change the order of the arguments below because ## the info-emacs-info script currently expects --directory DIR as ## the third and fourth arguments. Someone should fix that.
--- a/scripts/io/strread.m Wed Jun 25 12:51:55 2014 -0700 +++ b/scripts/io/strread.m Wed Jun 25 13:45:41 2014 -0700 @@ -245,8 +245,8 @@ elseif (iscellstr (varargin{n+1}) && numel (varargin{n+1}) == 2) [comment_start, comment_end] = deal (varargin{n+1}{:}); else - ## FIXME - a user may have numeric values specified: {'//', 7} - ## this will lead to an error in the warning message + ## FIXME: A user may have numeric values specified: {'//', 7} + ## this will lead to an error in the warning message error ("strread: unknown or unrecognized comment style '%s'", varargin{n+1}); endif @@ -677,8 +677,8 @@ endif ## Map to format - ## FIXME - add support for formats like "<%s>", "%[a-zA-Z]" - ## Someone with regexp experience is needed. + ## FIXME: Add support for formats like "<%s>", "%[a-zA-Z]" + ## Someone with regexp experience is needed. switch (fmt_words{m}(1:min (2, length (fmt_words{m})))) case "%s" if (pad_out) @@ -688,7 +688,7 @@ k++; case {"%d", "%u", "%f", "%n"} n = cellfun ("isempty", data); - ### FIXME - erroneously formatted data lead to NaN, not an error + ### FIXME: Erroneously formatted data lead to NaN, not an error data = str2double (data); if (! isempty (regexp (fmt_words{m}, "%[du]"))) ## Cast to integer @@ -709,8 +709,8 @@ switch (fmt_words{m}(ew+1)) case {"d", "u", "f", "n"} n = cellfun ("isempty", data); - ### FIXME - erroneously formatted data lead to NaN, not an error - ### => ReturnOnError can't be implemented for numeric data + ### FIXME: Erroneously formatted data lead to NaN, not an error + ### => ReturnOnError can't be implemented for numeric data data = str2double (strtrunc (data, swidth)); data(n) = numeric_fill_value; if (pad_out)
--- a/scripts/io/textread.m Wed Jun 25 12:51:55 2014 -0700 +++ b/scripts/io/textread.m Wed Jun 25 13:45:41 2014 -0700 @@ -135,7 +135,7 @@ endif ## Now that we know what EOL looks like, we can process format_repeat_count. - ## FIXME The below isn't ML-compatible: counts lines, not format string uses + ## FIXME: The below isn't ML-compatible: counts lines, not format string uses if (isfinite (nlines) && (nlines > 0)) l_eol_char = length (eol_char); eoi = findstr (str, eol_char);
--- a/scripts/linear-algebra/krylov.m Wed Jun 25 12:51:55 2014 -0700 +++ b/scripts/linear-algebra/krylov.m Wed Jun 25 13:45:41 2014 -0700 @@ -133,8 +133,8 @@ nv = columns (V); if (jj != nv) [V(:,jj), V(:,nv)] = swap (V(:,jj), V(:,nv)); - ## FIXME -- H columns should be swapped too. Not done - ## since Block Hessenberg structure is lost anyway. + ## FIXME: H columns should be swapped too. + ## Not done since Block Hessenberg structure is lost anyway. endif V = V(:,1:(nv-1)); ## One less reflection. @@ -167,7 +167,7 @@ ## Reduce V per the reflection. V(idx,:) = V(idx,:) - av*hv*(hv' * V(idx,:)); if(iter > 1) - ## FIXME -- not done correctly for block case. + ## FIXME: not done correctly for block case. H(nu,nu-1) = V(pivot_vec(nu),jj); endif
--- a/scripts/miscellaneous/colon.m Wed Jun 25 12:51:55 2014 -0700 +++ b/scripts/miscellaneous/colon.m Wed Jun 25 13:45:41 2014 -0700 @@ -42,5 +42,5 @@ %!error colon (1) -## FIXME -- what does colon () mean since it doesn't set a return value? +## FIXME: What does colon () mean since it doesn't set a return value?
--- a/scripts/miscellaneous/dump_prefs.m Wed Jun 25 12:51:55 2014 -0700 +++ b/scripts/miscellaneous/dump_prefs.m Wed Jun 25 13:45:41 2014 -0700 @@ -32,7 +32,7 @@ file = stdout; endif - ## FIXME -- it would be nice to be able to get the list of + ## FIXME: It would be nice to be able to get the list of ## built-in variables directly from Octave so that we wouldn't have to ## remember to update it each time the list of preference variables ## changes
--- a/scripts/miscellaneous/fileattrib.m Wed Jun 25 12:51:55 2014 -0700 +++ b/scripts/miscellaneous/fileattrib.m Wed Jun 25 13:45:41 2014 -0700 @@ -108,7 +108,7 @@ r_s{i} = NaN; r_h{i} = NaN; r_d{i} = S_ISDIR (info.mode); - ## FIXME -- maybe we should have S_IRUSR etc. masks? + ## FIXME: Maybe we should have S_IRUSR etc. masks? modestr = info.modestr; r_u_r{i} = modestr(2) == "r"; r_u_w{i} = modestr(3) == "w";
--- a/scripts/miscellaneous/getappdata.m Wed Jun 25 12:51:55 2014 -0700 +++ b/scripts/miscellaneous/getappdata.m Wed Jun 25 13:45:41 2014 -0700 @@ -35,8 +35,8 @@ function val = getappdata (h, name) if (all (ishandle (h)) && nargin == 2 && ischar (name)) - ## FIXME - Is there a better way to handle non-existent appdata - ## and missing fields? + ## FIXME: Is there a better way to handle non-existent appdata + ## and missing fields? val = cell (numel (h), 1); appdata = struct (); for nh = 1:numel (h)
--- a/scripts/miscellaneous/private/__xzip__.m Wed Jun 25 12:51:55 2014 -0700 +++ b/scripts/miscellaneous/private/__xzip__.m Wed Jun 25 13:45:41 2014 -0700 @@ -83,7 +83,7 @@ movefile (cellfun (@(x) sprintf ("%s.%s", x, extension), f, "uniformoutput", false), cwd); if (nargout > 0) - ## FIXME this does not work when you try to compress directories + ## FIXME: This does not work when you try to compress directories entries = cellfun (@(x) sprintf ("%s.%s", x, extension), files, "uniformoutput", false); endif @@ -109,8 +109,7 @@ endfunction -## FIXME -- reinstate these tests if we invent a way to test private -## functions directly. +## FIXME: Reinstate tests if we invent a way to test private functions directly. ## ## %!error <extension has to be a string with finite length> ## %! __xzip__ ("gzip", "", "gzip -r %s", "bla");
--- a/scripts/miscellaneous/unpack.m Wed Jun 25 12:51:55 2014 -0700 +++ b/scripts/miscellaneous/unpack.m Wed Jun 25 13:45:41 2014 -0700 @@ -84,10 +84,10 @@ ## If the file is a URL, download it and then work with that file. if (! isempty (strfind (file, "://"))) - ## FIXME -- the above is not a perfect test for a URL + ## FIXME: The above is not a perfect test for a URL urlfile = file; - ## FIXME -- should we name the file that we download with the - ## same file name as the URL requests? + ## FIXME: Should we name the file that we download with the + ## same file name as the URL requests? tmpfile = [tmpnam() ext]; [file, success, msg] = urlwrite (urlfile, tmpfile); if (! success) @@ -194,7 +194,7 @@ if (nargout > 0 || needmove) ## Trim the last CR if needed. - ## FIXME -- will this need to change to a check for "\r\n" for windows? + ## FIXME: Will this need to change to a check for "\r\n" for windows? if (output(end) == "\n") output(end) = []; endif
--- a/scripts/optimization/fsolve.m Wed Jun 25 12:51:55 2014 -0700 +++ b/scripts/optimization/fsolve.m Wed Jun 25 13:45:41 2014 -0700 @@ -382,7 +382,7 @@ ## iterations, so we need scaling-independent tolerances wherever ## possible. - ## FIXME -- why tolf*n*xn? If abs (e) ~ abs(x) * eps is a vector + ## FIXME: Why tolf*n*xn? If abs (e) ~ abs(x) * eps is a vector ## of perturbations of x, then norm (fjac*e) <= eps*n*xn, i.e. by ## tolf ~ eps we demand as much accuracy as we can expect. if (fn <= tolf*n*xn)
--- a/scripts/plot/appearance/axis.m Wed Jun 25 12:51:55 2014 -0700 +++ b/scripts/plot/appearance/axis.m Wed Jun 25 13:45:41 2014 -0700 @@ -194,7 +194,7 @@ "plotboxaspectratio", [1, 1, 1]); elseif (strcmp (ax, "equal")) if (strcmp (get (get (ca, "parent"), "__graphics_toolkit__"), "gnuplot")) - ## FIXME - gnuplot applies the aspect ratio activepostionproperty. + ## FIXME: gnuplot applies the aspect ratio activepostionproperty. set (ca, "activepositionproperty", "position"); ## The following line is a trick used to trigger the recalculation of ## aspect related magnitudes even if the aspect ratio is the same
--- a/scripts/plot/draw/meshc.m Wed Jun 25 12:51:55 2014 -0700 +++ b/scripts/plot/draw/meshc.m Wed Jun 25 13:45:41 2014 -0700 @@ -70,9 +70,9 @@ htmp = surface (varargin{:}); - ## FIXME - gnuplot does not support a filled surface and a - ## non-filled contour. 3D filled patches are also not supported. - ## Thus, the facecolor will be transparent for the gnuplot backend. + ## FIXME: gnuplot does not support a filled surface and a + ## non-filled contour. 3D filled patches are also not supported. + ## Thus, the facecolor will be transparent for the gnuplot backend. set (htmp, "facecolor", "w"); set (htmp, "edgecolor", "flat"); if (! ishold ())
--- a/scripts/plot/util/print.m Wed Jun 25 12:51:55 2014 -0700 +++ b/scripts/plot/util/print.m Wed Jun 25 13:45:41 2014 -0700 @@ -619,7 +619,7 @@ dos_shell = (ispc () && ! isunix ()); if (! isempty (opts.fig2dev_binary)) if (dos_shell) - ## FIXME - is this the right thing to do for DOS? + ## FIXME: Is this the right thing to do for DOS? cmd = sprintf ("%s -L %s 2> NUL", opts.fig2dev_binary, devopt); else cmd = sprintf ("%s -L %s 2> /dev/null", opts.fig2dev_binary, devopt); @@ -717,7 +717,7 @@ if (dos_shell) cmd = sprintf ("%s -f %s 2> NUL", opts.pstoedit_binary, devopt); else - ## FIXME - is this the right thing to do for DOS? + ## FIXME: Is this the right thing to do for DOS? cmd = sprintf ("%s -f %s 2> /dev/null", opts.pstoedit_binary, devopt); endif elseif (isempty (opts.pstoedit_binary))
--- a/scripts/plot/util/private/__ghostscript__.m Wed Jun 25 12:51:55 2014 -0700 +++ b/scripts/plot/util/private/__ghostscript__.m Wed Jun 25 13:45:41 2014 -0700 @@ -143,9 +143,9 @@ endif if (! isempty (opts.prepend) && any (strcmpi (opts.device, {"pswrite", "ps2write", "pdfwrite"}))) - ## FIXME - Fonts get may be mangled when appending ps/ps2. - ## See "How to concatenate several PS files" at the link, - ## http://en.wikibooks.org/wiki/PostScript_FAQ + ## FIXME: Fonts get may be mangled when appending ps/ps2. + ## See "How to concatenate several PS files" at the link, + ## http://en.wikibooks.org/wiki/PostScript_FAQ cmd = sprintf ("%s %s", cmd, opts.prepend); if (isempty (cleanup_cmd)) cleanup_cmd = sprintf ("rm %s", opts.prepend);
--- a/scripts/plot/util/private/__go_draw_axes__.m Wed Jun 25 12:51:55 2014 -0700 +++ b/scripts/plot/util/private/__go_draw_axes__.m Wed Jun 25 13:45:41 2014 -0700 @@ -63,7 +63,7 @@ && strcmp (axis_obj.xlimmode, "manual") && strcmp (axis_obj.ylimmode, "manual") && (nd == 2 || all (mod (axis_obj.view, 90) == 0))) - ## FIXME - adjust plotboxaspectratio to respect other + ## FIXME: adjust plotboxaspectratio to respect other fpos = get (axis_obj.parent, "position"); apos = axis_obj.position; endif @@ -75,7 +75,7 @@ if (nd == 2 || all (mod (axis_obj.view, 90) == 0)) dr = dr(1) / dr(2); else - ## FIXME - need to properly implement 3D + ## FIXME: need to properly implement 3D dr = mean (dr(1:2)) / dr(3); endif else @@ -106,7 +106,7 @@ fprintf (plot_stream, "set rmargin 0;\n"); if (nd == 3 && all (axis_obj.view == [0, 90])) - ## FIXME -- Kludge to allow colorbar to be added to a pcolor() plot + ## FIXME: Kludge to allow colorbar to be added to a pcolor() plot pos(3:4) = pos(3:4) * 1.4; pos(1:2) = pos(1:2) - pos(3:4) * 0.125; endif @@ -139,8 +139,8 @@ endif ## Reset all labels, axis-labels, tick-labels, and title - ## FIXME - We should have an function to initialize the axis. - ## Presently, this is dispersed in this function. + ## FIXME: We should have an function to initialize the axis. + ## Presently, this is dispersed in this function. fputs (plot_stream, "unset label;\n"); fputs (plot_stream, "unset xtics;\n"); fputs (plot_stream, "unset ytics;\n"); @@ -323,9 +323,9 @@ fputs (plot_stream, "set border front;\n"); else fputs (plot_stream, "set grid layerdefault;\n"); - ## FIXME -- the gnuplot help says that "layerdefault" should work - ## for set border too, but it fails for me with gnuplot 4.2.5. So - ## use "back" instead. + ## FIXME: The gnuplot help says that "layerdefault" should work + ## for set border too, but it fails for me with gnuplot 4.2.5. + ## So, use "back" instead. fputs (plot_stream, "set border back;\n"); endif @@ -800,12 +800,11 @@ endif if (isfield (obj, "edgecolor")) - ## FIXME - ## This is the wrong thing to do as edgecolor, markeredgecolor - ## and markerfacecolor can have different values and we should - ## treat them seperately. However, the below allow the scatter - ## functions to work as expected, where only one of these values - ## is set + ## FIXME: This is the wrong thing to do as edgecolor, + ## markeredgecolor and markerfacecolor can have different values + ## and we should treat them seperately. However, the code below + ## allows the scatter functions to work as expected, where only + ## one of these values is set. if (strcmp (obj.edgecolor, "none")) if (strcmp (obj.markeredgecolor, "none")) ec = obj.markerfacecolor; @@ -1969,19 +1968,19 @@ pt = "10"; pt2 = "11"; case ">" - ## FIXME: should be triangle pointing right, use triangle pointing up + ## FIXME: Should be triangle pointing right, use triangle pointing up pt = "8"; pt2 = "9"; case "<" - ## FIXME: should be triangle pointing left, use triangle pointing down + ## FIXME: Should be triangle pointing left, use triangle pointing down pt = "10"; pt2 = "11"; case {"pentagram", "p"} - ## FIXME: should be pentagram, using pentagon + ## FIXME: Should be pentagram, using pentagon pt = "14"; pt2 = "15"; case {"hexagram", "h"} - ## FIXME: should be 6 pt start, using "*" instead + ## FIXME: Should be 6 pt start, using "*" instead pt = pt2 = "3"; case "none" pt = pt2 = ""; @@ -1997,7 +1996,7 @@ ## DATA is already transposed. - ## FIXME -- this may need to be converted to C++ for speed. + ## FIXME: this may need to be converted to C++ for speed. ## Convert NA elements to normal NaN values because fprintf writes ## "NA" and that confuses gnuplot. @@ -2298,7 +2297,7 @@ f = m{i}(2:end); if (isfield (sym, f)) g = getfield (sym, f); - ## FIXME The symbol font doesn't seem to support bold or italic + ## FIXME: The symbol font doesn't seem to support bold or italic ##if (bld) ## if (it) ## g = regexprep (g, '/Symbol', '/Symbol-bolditalic'); @@ -2328,7 +2327,7 @@ str = [str(1:s(i) - 1) '/' fnt '-bold ' str(s(i) + 3:end)]; endif elseif (strcmpi (f, "color")) - ## FIXME Ignore \color but remove trailing {} block as well + ## FIXME: Ignore \color but remove trailing {} block as well d = strfind (str(e(i) + 1:end),'}'); if (isempty (d)) warning ('syntax error in \color argument'); @@ -2359,7 +2358,7 @@ for j = 1 : length (flds) if (strncmp (flds{j}, f, length (flds{j}))) g = getfield (sym, flds{j}); - ## FIXME The symbol font doesn't seem to support bold or italic + ## FIXME: The symbol font doesn't seem to support bold or italic ##if (bld) ## if (it) ## g = regexprep (g, '/Symbol', '/Symbol-bolditalic'); @@ -2383,7 +2382,7 @@ ## shortest.. Don't have to worry about things like ^\theta as they ## are already converted to ^{/Symbol q}. - ## FIXME -- This is a mess... Is it worth it just for a "@" character? + ## FIXME: This is a mess... Is it worth it just for a "@" character? [s, m] = regexp (str,'[_\^]','start','matches'); i = 1;
--- a/scripts/plot/util/private/__print_parse_opts__.m Wed Jun 25 12:51:55 2014 -0700 +++ b/scripts/plot/util/private/__print_parse_opts__.m Wed Jun 25 13:45:41 2014 -0700 @@ -298,7 +298,7 @@ arg_st.devopt = aliases.(arg_st.devopt); endif - ## FIXME - eps2 & epsc2 needs to be handled + ## FIXME: eps2 & epsc2 needs to be handled if (strcmp (arg_st.devopt, "pswrite")) arg_st.ghostscript.level = 1; elseif (strcmp (arg_st.devopt, "ps2write")) @@ -580,8 +580,8 @@ paperposition = convert2points (paperposition, paperunits); endif - ## FIXME - This will be obsoleted by listeners for paper properties. - ## Papersize is tall when portrait,and wide when landscape. + ## FIXME: This will be obsoleted by listeners for paper properties. + ## Papersize is tall when portrait,and wide when landscape. if ((papersize(1) > papersize(2) && strcmpi (paperorientation, "portrait")) || (papersize(1) < papersize(2) && strcmpi (paperorientation, "landscape"))) papersize = papersize([2,1]);
--- a/scripts/plot/util/struct2hdl.m Wed Jun 25 12:51:55 2014 -0700 +++ b/scripts/plot/util/struct2hdl.m Wed Jun 25 13:45:41 2014 -0700 @@ -451,7 +451,7 @@ elseif (isfield (fields, "bargroup")) ## bar plot - ## FIXME - here we don't have access to brothers so we first create all + ## FIXME: Here we don't have access to brothers so we first create all ## the barseries of the bargroup (but the last), then retrieve information, ## and rebuild the whole bargroup. ## The duplicate are deleted after calling "setprops"
--- a/scripts/set/unique.m Wed Jun 25 12:51:55 2014 -0700 +++ b/scripts/set/unique.m Wed Jun 25 13:45:41 2014 -0700 @@ -76,7 +76,7 @@ optrows = false; endif - ## FIXME -- the operations + ## FIXME: The operations ## ## match = (y(1:n-1) == y(2:n)); ## y(idx) = [];
--- a/scripts/sparse/spstats.m Wed Jun 25 12:51:55 2014 -0700 +++ b/scripts/sparse/spstats.m Wed Jun 25 13:45:41 2014 -0700 @@ -50,7 +50,7 @@ mean = sum (S) ./ count; endif if (nargout > 2) - ## FIXME Variance with count = 0 or 1? + ## FIXME: Variance with count = 0 or 1? diff = S - sparse (i, j, mean (j), n, m); var = sum (diff .* diff) ./ (count - 1); endif
--- a/scripts/sparse/treeplot.m Wed Jun 25 12:51:55 2014 -0700 +++ b/scripts/sparse/treeplot.m Wed Jun 25 13:45:41 2014 -0700 @@ -156,9 +156,9 @@ ## of most left and most right descendants). x_coordinate = (x_coordinate_l + x_coordinate_r) / 2; - ## FIXME -- we should probably stuff all the arguments into a cell - ## array and make a single call to plot here so we can avoid - ## setting the hold state... + ## FIXME: We should probably stuff all the arguments into a cell + ## array and make a single call to plot here so we can avoid + ## setting the hold state... hold_is_on = ishold (); unwind_protect
--- a/scripts/testfun/test.m Wed Jun 25 12:51:55 2014 -0700 +++ b/scripts/testfun/test.m Wed Jun 25 13:45:41 2014 -0700 @@ -720,7 +720,7 @@ %!demo toeplitz ([1,2,3,4],[1,5,6]) ### example from kron -%!#error kron # FIXME suppress these until we can handle output +%!#error kron # FIXME: suppress these until we can handle output %!#error kron(1,2,3) %!test assert (isempty (kron ([], rand (3, 4)))) %!test assert (isempty (kron (rand (3, 4), [])))
--- a/scripts/time/datestr.m Wed Jun 25 12:51:55 2014 -0700 +++ b/scripts/time/datestr.m Wed Jun 25 13:45:41 2014 -0700 @@ -267,7 +267,7 @@ tm.sec = fix (sec); tm.usec = fix ((sec - tm.sec) * 1e6); tm.wday = wday - 1; - ## FIXME -- Do we need YDAY and DST? How should they be computed? + ## FIXME: Do we need YDAY and DST? How should they be computed? ## We don't want to use "localtime (mktime (tm))" because that ## doesn't correctly handle dates before 1970-01-01 on some systems. ## tm.yday = ?;