Mercurial > octave
changeset 26577:ae1542fb58ba stable
documentation: Avoid some overfull lines in the PDF manual.
* plot.txi, cellfun.cc (Fnum2cell, Fmat2cell), circshift.m, inputdlg.m,
questdlg.m, uicontextmenu.m, uicontrol.m, uipanel.m, uitable.m, pkg.m,
erase.m, strsplit.m: Break some long lines in examples.
* warning_ids.m: Insert sentence to get better line break.
| author | Markus Mützel <markus.muetzel@gmx.de> |
|---|---|
| date | Sat, 19 Jan 2019 15:59:59 +0100 |
| parents | 49eae759a3e2 |
| children | ab06235daf33 |
| files | doc/interpreter/plot.txi libinterp/corefcn/cellfun.cc scripts/general/circshift.m scripts/gui/inputdlg.m scripts/gui/questdlg.m scripts/gui/uicontextmenu.m scripts/gui/uicontrol.m scripts/gui/uipanel.m scripts/gui/uitable.m scripts/help/warning_ids.m scripts/pkg/pkg.m scripts/strings/erase.m scripts/strings/strsplit.m |
| diffstat | 13 files changed, 86 insertions(+), 50 deletions(-) [+] |
line wrap: on
line diff
--- a/doc/interpreter/plot.txi Sat Jan 19 14:44:29 2019 +0100 +++ b/doc/interpreter/plot.txi Sat Jan 19 15:59:59 2019 +0100 @@ -1069,8 +1069,9 @@ hold on; plot (x, x, "r"); axis ([0, 3, 0, 1]); -text (0.65, 0.6175, ['$\displaystyle\leftarrow x = @{2 \over \sqrt@{\pi@}@}'... - '\int_@{0@}^@{x@} e^@{-t^2@} dt = 0.6175$'], +text (0.65, 0.6175, ... + ['$\displaystyle\leftarrow x = @{2 \over \sqrt@{\pi@}@}'... + '\int_@{0@}^@{x@} e^@{-t^2@} dt = 0.6175$'], "interpreter", "latex"); xlabel ("x"); ylabel ("erf (x)");
--- a/libinterp/corefcn/cellfun.cc Sat Jan 19 14:44:29 2019 +0100 +++ b/libinterp/corefcn/cellfun.cc Sat Jan 19 15:59:59 2019 +0100 @@ -1808,7 +1808,8 @@ [2,1] = 3 4 @} -## all rows and cols appear in each element of C (hence, only 1 output) +## all rows and cols appear in each element of C +## (hence, only 1 output) num2cell (x, [1, 2]) @result{} @{ @@ -2136,8 +2137,10 @@ 10 11 12 @group -## The 4 rows (dim1) are divided in to two cell elements with 2 rows each. -## The 3 cols (dim2) are divided in to three cell elements with 1 col each. +## The 4 rows (dim1) are divided in to two cell elements +## with 2 rows each. +## The 3 cols (dim2) are divided in to three cell elements +## with 1 col each. mat2cell (x, [2,2], [1,1,1]) @result{} @{ @@ -2172,7 +2175,8 @@ @end group @group -## The 4 rows (dim1) are divided in to two cell elements with a 3/1 split. +## The 4 rows (dim1) are divided in to two cell elements +## with a 3/1 split. ## All columns appear in each output element. mat2cell (x, [3,1]) @result{}
--- a/scripts/general/circshift.m Sat Jan 19 14:44:29 2019 +0100 +++ b/scripts/general/circshift.m Sat Jan 19 15:59:59 2019 +0100 @@ -37,19 +37,23 @@ ## x = [1, 2, 3; ## 4, 5, 6; ## 7, 8, 9]; -## circshift (x, 1) # positive shift on rows (1st non-singular dim) +## ## positive shift on rows (1st non-singular dim) +## circshift (x, 1) ## @result{} 7, 8, 9 ## 1, 2, 3 ## 4, 5, 6 -## circshift (x, -2) # negative shift on rows (1st non-singular dim) +## ## negative shift on rows (1st non-singular dim) +## circshift (x, -2) ## @result{} 7, 8, 9 ## 1, 2, 3 ## 4, 5, 6 -## circshift (x, [0,1]) # no shift of rows, shift columns by 1 (2nd dimension) +## ## no shift of rows, shift columns by 1 (2nd dimension) +## circshift (x, [0,1]) ## @result{} 3, 1, 2 ## 6, 4, 5 ## 9, 7, 8 -## circshift (x, 1, 2) # shift columns (2nd dimension) +## ## shift columns (2nd dimension) +## circshift (x, 1, 2) ## @result{} 3, 1, 2 ## 6, 4, 5 ## 9, 7, 8
--- a/scripts/gui/inputdlg.m Sat Jan 19 14:44:29 2019 +0100 +++ b/scripts/gui/inputdlg.m Sat Jan 19 15:59:59 2019 +0100 @@ -67,7 +67,8 @@ ## prompt = @{"Width", "Height", "Depth"@}; ## defaults = @{"1.10", "2.20", "3.30"@}; ## rowscols = [1,10; 2,20; 3,30]; -## dims = inputdlg (prompt, "Enter Box Dimensions", rowscols, defaults); +## dims = inputdlg (prompt, "Enter Box Dimensions", ... +## rowscols, defaults); ## @end group ## @end example ##
--- a/scripts/gui/questdlg.m Sat Jan 19 14:44:29 2019 +0100 +++ b/scripts/gui/questdlg.m Sat Jan 19 15:59:59 2019 +0100 @@ -47,7 +47,8 @@ ## ## @example ## @group -## btn = questdlg ("Close Octave?", "Some fancy title", "Yes", "No", "No"); +## btn = questdlg ("Close Octave?", "Some fancy title", ... +## "Yes", "No", "No"); ## if (strcmp (btn, "Yes")) ## exit (); ## endif
--- a/scripts/gui/uicontextmenu.m Sat Jan 19 14:44:29 2019 +0100 +++ b/scripts/gui/uicontextmenu.m Sat Jan 19 15:59:59 2019 +0100 @@ -36,15 +36,17 @@ ## ## @example ## @group -## % create figure and uicontextmenu -## f = figure; +## ## create figure and uicontextmenu +## f = figure (); ## c = uicontextmenu (f); ## -## % create menus in the context menu -## m1 = uimenu ("parent",c,"label","Menu item 1","callback","disp('menu item 1')"); -## m2 = uimenu ("parent",c,"label","Menu item 2","callback","disp('menu item 2')"); +## ## create menus in the context menu +## m1 = uimenu ("parent", c, "label", "Menu item 1", ... +## "callback", "disp('menu item 1')"); +## m2 = uimenu ("parent", c, "label", "Menu item 2", ... +## "callback", "disp('menu item 2')"); ## -## % set the context menu for the figure +## ## set the context menu for the figure ## set (f, "uicontextmenu", c); ## @end group ## @end example
--- a/scripts/gui/uicontrol.m Sat Jan 19 14:44:29 2019 +0100 +++ b/scripts/gui/uicontrol.m Sat Jan 19 15:59:59 2019 +0100 @@ -86,7 +86,8 @@ ## ## Create figure and panel on it ## f = figure; ## ## Create a button (default style) -## b1 = uicontrol (f, "string", "A Button", "position", [10 10 150 40]); +## b1 = uicontrol (f, "string", "A Button", ... +## "position", [10 10 150 40]); ## ## Create an edit control ## e1 = uicontrol (f, "style", "edit", "string", "editable text", ... ## "position", [10 60 300 40]);
--- a/scripts/gui/uipanel.m Sat Jan 19 14:44:29 2019 +0100 +++ b/scripts/gui/uipanel.m Sat Jan 19 15:59:59 2019 +0100 @@ -18,7 +18,7 @@ ## -*- texinfo -*- ## @deftypefn {} {} uipanel (@var{property}, @var{value}, @dots{}) -## @deftypefnx {} {} uipanel (@var{parent}, "@var{property}, @var{value}, @dots{}) +## @deftypefnx {} {} uipanel (@var{parent}, @var{property}, @var{value}, @dots{}) ## @deftypefnx {} {@var{hui} =} uipanel (@dots{}) ## ## Create a uipanel object. @@ -42,13 +42,15 @@ ## ## @example ## @group -## % create figure and panel on it +## ## create figure and panel on it ## f = figure; ## p = uipanel ("title", "Panel Title", "position", [.25 .25 .5 .5]); ## -## % add two buttons to the panel -## b1 = uicontrol ("parent", p, "string", "A Button", "position",[18 10 150 36]); -## b2 = uicontrol ("parent", p, "string", "Another Button", "position",[18 60 150 36]); +## ## add two buttons to the panel +## b1 = uicontrol ("parent", p, "string", "A Button", ... +## "position", [18 10 150 36]); +## b2 = uicontrol ("parent", p, "string", "Another Button", ... +## "position",[18 60 150 36]); ## ## @end group ## @end example
--- a/scripts/gui/uitable.m Sat Jan 19 14:44:29 2019 +0100 +++ b/scripts/gui/uitable.m Sat Jan 19 15:59:59 2019 +0100 @@ -82,9 +82,11 @@ ## ## popup_options = @{"A", "B", "C", "D", "E"@}; ## -## columnformat_options = @{ "[]", "char", "pop-up", "numeric", "short", "short e", ... -## "short eng", "short g", "long", "long e", "long eng", ... -## "long g", "bank", "+", "rat", "logical"@}; +## columnformat_options = @{ "[]", "char", "pop-up", "numeric", ... +## "short", "short e", "short eng", ... +## "short g", "long", "long e", ... +## "long eng", "long g", "bank", "+", ... +## "rat", "logical"@}; ## columnformat_values = columnformat_options; ## columnformat_values@{1@} = ""; ## columnformat_values@{3@} = popup_options; @@ -117,32 +119,42 @@ ## l_editable_table = uicontrol (f, "Position", [ 0 502 200 25 ], ... ## "Style", "text", ... ## "String", "Set Data Columns Editable:"); -## t_editable_table = uitable (f, "Position", [ 0 434 1000 65 ], ... -## "Data", repmat (false, 1, columns (default_data)), ... -## "ColumnEditable", true); +## t_editable_table = ... +## uitable (f, "Position", [ 0 434 1000 65 ], ... +## "Data", repmat (false, 1, columns (default_data)), ... +## "ColumnEditable", true); ## ## l_format_table = uicontrol (f, "Position", [ 0 406 200 25 ], ... ## "Style", "text", ... ## "String", "Set Data Column Format:"); -## t_format_table = uitable (f, "Position", [ 0 338 1000 65 ], ... -## "Data", columnformat_options, ... -## "ColumnEditable", true, ... -## "ColumnFormat", arrayfun (@@(x) @{columnformat_options@}, 1:columns (columnformat_options))); +## t_format_table = ... +## uitable (f, "Position", [ 0 338 1000 65 ], ... +## "Data", columnformat_options, ... +## "ColumnEditable", true, ... +## "ColumnFormat", arrayfun (@@(x) @{columnformat_options@}, ... +## 1:columns (columnformat_options))); ## -## l_data_table = uicontrol (f, "Style", "text", "String", "Data:", "Position", [ 0 310 60 25 ]); +## l_data_table = uicontrol (f, "Style", "text", ... +## "String", "Data:", ... +## "Position", [ 0 310 60 25 ]); ## t_data_table = uitable (f, "Position", [ 0 15 1000 290 ], ... ## "Data", default_data, ... ## "ColumnFormat", columnformat_values); ## -## set (t_format_table, "CellEditCallback", ... -## @@(x, y) update_column_format (y.NewData, y.Indices, t_data_table, popup_options)); +## set (t_format_table, ... +## "CellEditCallback", ... +## @@(x, y) update_column_format (y.NewData, y.Indices, ... +## t_data_table, popup_options)); ## set (t_point_table, "CellEditCallback", ... -## @@(x, y) validate_point_table (x, y, t_data_table)); -## set (t_editable_table, "CellEditCallback", @@(x,y) set (t_data_table, ... -## "ColumnEditable", get (t_editable_table, "Data"))); -## set (b_add, "Callback", @@(x, y) ... -## update_data (b_add, t_point_table, t_type_table, t_data_table)); -## set (t_data_table, "cellselectioncallback", @@(x, y) update_point_table (y.Indices, t_point_table)); +## @@(x, y) validate_point_table (x, y, t_data_table)); +## set (t_editable_table, "CellEditCallback", ... +## @@(x,y) set (t_data_table, ... +## "ColumnEditable", get (t_editable_table, "Data"))); +## set (b_add, ... +## "Callback", @@(x, y) update_data (b_add, t_point_table, ... +## t_type_table, t_data_table)); +## set (t_data_table, "CellSelectionCallback", ... +## @@(x, y) update_point_table (y.Indices, t_point_table)); ## endfunction ## ## function validate_point_table (h, dat, t_data_table) @@ -155,7 +167,8 @@ ## endif ## endfunction ## -## function update_column_format (format, indices, t_data_table, popup_options) +## function update_column_format (format, indices, t_data_table, ... +## popup_options) ## cf = get (t_data_table, "ColumnFormat"); ## if (strcmp (format, "[]")) ## format = ""; @@ -173,7 +186,8 @@ ## set (t_point_table, "Data", indices(1,:)); ## endfunction ## -## function update_data (b_add, t_point_table, t_type_table, t_data_table) +## function update_data (b_add, t_point_table, t_type_table, ... +## t_data_table) ## indices = get (b_add, "UserData"); ## if (isempty (indices)) ## indices = [1, 1];
--- a/scripts/help/warning_ids.m Sat Jan 19 14:44:29 2019 +0100 +++ b/scripts/help/warning_ids.m Sat Jan 19 15:59:59 2019 +0100 @@ -247,6 +247,7 @@ ## ## @item Octave:nearly-singular-matrix ## @itemx Octave:singular-matrix +## These warnings are emitted if a (nearly) singular matrix is inverted. ## By default, the @code{Octave:nearly-singular-matrix} and ## @code{Octave:singular-matrix} warnings are enabled. ##
--- a/scripts/pkg/pkg.m Sat Jan 19 14:44:29 2019 +0100 +++ b/scripts/pkg/pkg.m Sat Jan 19 15:59:59 2019 +0100 @@ -186,7 +186,8 @@ ## Display can be limited to a set of packages: ## ## @example -## pkg describe control signal # describe control and signal packages +## ## describe control and signal packages +## pkg describe control signal ## @end example ## ## If one output is requested a cell of structure containing the
--- a/scripts/strings/erase.m Sat Jan 19 14:44:29 2019 +0100 +++ b/scripts/strings/erase.m Sat Jan 19 15:59:59 2019 +0100 @@ -36,11 +36,13 @@ ## @result{} @{"Hello", "!"@} ## ## ## string, multiple patterns -## erase ("The Octave interpreter is fabulous", @{"interpreter ", "The "@}) +## erase ("The Octave interpreter is fabulous", ... +## @{"interpreter ", "The "@}) ## @result{} "Octave is fabulous" ## ## ## cellstr, multiple patterns -## erase (@{"The ", "Octave interpreter ", "is fabulous"@}, @{"interpreter ", "The "@}) +## erase (@{"The ", "Octave interpreter ", "is fabulous"@}, ... +## @{"interpreter ", "The "@}) ## @result{} @{"", "Octave ", "is fabulous"@} ## @end group ## @end example
--- a/scripts/strings/strsplit.m Sat Jan 19 14:44:29 2019 +0100 +++ b/scripts/strings/strsplit.m Sat Jan 19 15:59:59 2019 +0100 @@ -87,7 +87,8 @@ ## Examples with @nospell{regularexpression} delimiters: ## ## @smallexample -## strsplit ("a foo b,bar c", ',|\s|foo|bar', "delimitertype", "regularexpression") +## strsplit ("a foo b,bar c", ',|\s|foo|bar', ... +## "delimitertype", "regularexpression") ## @result{} ## @{ ## [1,1] = a @@ -95,7 +96,8 @@ ## [1,3] = c ## @} ## -## strsplit ("a,,b, c", '[, ]', "collapsedelimiters", false, "delimitertype", "regularexpression") +## strsplit ("a,,b, c", '[, ]', "collapsedelimiters", false, ... +## "delimitertype", "regularexpression") ## @result{} ## @{ ## [1,1] = a