From 75635a82b5d085189f70caf0e14784cb12bc39c2 Mon Sep 17 00:00:00 2001 From: Stanislav KROTER Date: Wed, 3 Apr 2013 20:52:11 +0600 Subject: [PATCH] Revision of English help pages for different functions (nothing serious). Change-Id: I237b04f4370c983fe46bd24e061159038f0ec1bb --- .../modules/core/help/en_US/debugging/whereami.xml | 4 ++-- .../core/help/en_US/variables/clearglobal.xml | 12 ++++++++---- .../modules/core/help/en_US/variables/isglobal.xml | 4 ++-- .../modules/core/help/en_US/variables/who_user.xml | 12 +++++++----- scilab/modules/core/help/en_US/variables/whos.xml | 15 ++++++++++----- .../modules/data_structures/help/en_US/boolean.xml | 2 +- .../data_structures/help/en_US/getfield.xml | 2 +- .../modules/data_structures/help/en_US/rlist.xml | 1 - .../modules/data_structures/help/en_US/tlist.xml | 7 ++++--- .../differential_equations/help/en_US/dasrt.xml | 7 +++++-- .../help/en_US/elementarymatrices/linspace.xml | 1 + .../help/en_US/elementarymatrices/logspace.xml | 3 ++- .../help/en_US/signalprocessing/trfmod.xml | 2 +- scilab/modules/fileio/help/en_US/mdelete.xml | 7 +++---- scilab/modules/fileio/help/en_US/mopen.xml | 2 +- scilab/modules/fileio/help/en_US/mtell.xml | 2 +- .../fileio/help/en_US/path_filename/basename.xml | 6 ++++-- 17 files changed, 53 insertions(+), 36 deletions(-) diff --git a/scilab/modules/core/help/en_US/debugging/whereami.xml b/scilab/modules/core/help/en_US/debugging/whereami.xml index 96c05f3..afd66c6 100644 --- a/scilab/modules/core/help/en_US/debugging/whereami.xml +++ b/scilab/modules/core/help/en_US/debugging/whereami.xml @@ -11,8 +11,8 @@ Description - Displays calling tree to instruction which contain whereami(). May be - used within pause levels. + Displays calling tree to instruction which contain whereami(). May be + used within pause levels. diff --git a/scilab/modules/core/help/en_US/variables/clearglobal.xml b/scilab/modules/core/help/en_US/variables/clearglobal.xml index ddd1097..7fd744f 100644 --- a/scilab/modules/core/help/en_US/variables/clearglobal.xml +++ b/scilab/modules/core/help/en_US/variables/clearglobal.xml @@ -6,7 +6,8 @@ Calling Sequence - clearglobal() + + clearglobal() clearglobal nam1 ... namn clearglobal('nam1', ...,'namn') @@ -25,15 +26,18 @@ Description - clearglobal() kills all the global variables. + clearglobal() kills all the global variables. clearglobal nam1 ... namn kills the global variables given by their names. - Note that clearglobal() only clears the global variables, the - local copies of these global variables are not destroyed. + + Note that clearglobal() only clears + the global variables, the local copies of these global + variables are not destroyed. + diff --git a/scilab/modules/core/help/en_US/variables/isglobal.xml b/scilab/modules/core/help/en_US/variables/isglobal.xml index ebb8ccf..c63841b 100644 --- a/scilab/modules/core/help/en_US/variables/isglobal.xml +++ b/scilab/modules/core/help/en_US/variables/isglobal.xml @@ -6,7 +6,7 @@ Calling Sequence - t=isglobal(x) + t = isglobal(x) Arguments @@ -28,7 +28,7 @@ Description - isglobal(x) returns true if x has been declared to be a global + isglobal(x) returns true if x has been declared to be a global variable and false otherwise. diff --git a/scilab/modules/core/help/en_US/variables/who_user.xml b/scilab/modules/core/help/en_US/variables/who_user.xml index 2e89c92..c2890f8 100644 --- a/scilab/modules/core/help/en_US/variables/who_user.xml +++ b/scilab/modules/core/help/en_US/variables/who_user.xml @@ -15,7 +15,7 @@ bPrint - Enable or disable screen outputs (Default: %t). + enable or disable screen outputs (default: %t). @@ -28,7 +28,7 @@ varList - Column vector of user's variables or [] if user does not have variable. + a column vector of user's variables or [] if user does not have variable. @@ -42,8 +42,7 @@ Examples - - 5.4.0 - who_user can now return user's variable names in a column vector of character strings. + + who_user can now return user's + variable names in a column vector of character strings. + diff --git a/scilab/modules/core/help/en_US/variables/whos.xml b/scilab/modules/core/help/en_US/variables/whos.xml index 8a94739..899d2b5 100644 --- a/scilab/modules/core/help/en_US/variables/whos.xml +++ b/scilab/modules/core/help/en_US/variables/whos.xml @@ -6,7 +6,8 @@ Calling Sequence - whos() + + whos() whos -type typ whos -name nam @@ -33,15 +34,19 @@ Description - whos() displays all current variable names sorted by name (case insensitive), types and memory used. + whos() displays all current variable names + sorted by name (case insensitive), types and memory used. - whos -type typ displays all current variables with specified type. + whos -type typ displays all current variables with specified type typ. - whos -name nam displays all current variables whose names begin with nam. + whos -name nam displays all current variables whose names begin with nam. - Note : If a variable is global, a * appears after his type name. + + + Note: If a variable is global, a * appears after its type name. + Examples diff --git a/scilab/modules/data_structures/help/en_US/boolean.xml b/scilab/modules/data_structures/help/en_US/boolean.xml index 5c1a2ca..65019f3 100644 --- a/scilab/modules/data_structures/help/en_US/boolean.xml +++ b/scilab/modules/data_structures/help/en_US/boolean.xml @@ -18,7 +18,7 @@ Description - A boolean variable is %T (for "true") or %F (for "false"). These variables can be used to define matrices of booleans, with the usual syntax. Boolean matrices can be manipulated as ordinary matrices for elements extraction/insertion and concatenation. Note that other usual operations (+, *, -, ^, etc) are undefined for boolean matrices. Тhree special operators are defined for boolean matrices: + A boolean variable is %T (for "true") or %F (for "false"). These variables can be used to define matrices of booleans, with the usual syntax. Boolean matrices can be manipulated as ordinary matrices for elements extraction/insertion and concatenation. Note that other usual operations (+, *, -, ^, etc) are undefined for boolean matrices. Three special operators are defined for boolean matrices: diff --git a/scilab/modules/data_structures/help/en_US/getfield.xml b/scilab/modules/data_structures/help/en_US/getfield.xml index bcdddf0..4db00fe 100644 --- a/scilab/modules/data_structures/help/en_US/getfield.xml +++ b/scilab/modules/data_structures/help/en_US/getfield.xml @@ -17,7 +17,7 @@ Calling Sequence - [x,...]=getfield(i,l) + [x,...] = getfield(i,l) Arguments diff --git a/scilab/modules/data_structures/help/en_US/rlist.xml b/scilab/modules/data_structures/help/en_US/rlist.xml index f9be5ee..56d8186 100644 --- a/scilab/modules/data_structures/help/en_US/rlist.xml +++ b/scilab/modules/data_structures/help/en_US/rlist.xml @@ -44,7 +44,6 @@ Den=[s*s,s;s,s*s]; rlist(Num,Den,[]) ]]> - See Also diff --git a/scilab/modules/data_structures/help/en_US/tlist.xml b/scilab/modules/data_structures/help/en_US/tlist.xml index 41ea9ef..eb9c33f 100644 --- a/scilab/modules/data_structures/help/en_US/tlist.xml +++ b/scilab/modules/data_structures/help/en_US/tlist.xml @@ -71,7 +71,8 @@ l(i)=null() removes the i-th - element of the tlist l. + element of the tlist l. + Note that the semantics of l.x=null() is undefined, but a definition can be given through the overloading mechanism. @@ -79,8 +80,8 @@ display. - Moreover if typ(2:n+1) are specified, user may point elements by - their names. + Moreover if typ(2:n+1) are specified, user may + point elements by their names. We give below examples where tlist are used. diff --git a/scilab/modules/differential_equations/help/en_US/dasrt.xml b/scilab/modules/differential_equations/help/en_US/dasrt.xml index 85ebb8f..764b6f2 100644 --- a/scilab/modules/differential_equations/help/en_US/dasrt.xml +++ b/scilab/modules/differential_equations/help/en_US/dasrt.xml @@ -130,8 +130,11 @@ r=res(t,y,ydot,x1,x2,...) r=g(t,y,ydot) as a function of (t,y,ydot,x1,x2,...). - Warning: this form must not be used if there is no extra - argument to pass to the function. + + + Warning: this form must not be used if there is no extra + argument to pass to the function. + diff --git a/scilab/modules/elementary_functions/help/en_US/elementarymatrices/linspace.xml b/scilab/modules/elementary_functions/help/en_US/elementarymatrices/linspace.xml index e28056c..29babd0 100644 --- a/scilab/modules/elementary_functions/help/en_US/elementarymatrices/linspace.xml +++ b/scilab/modules/elementary_functions/help/en_US/elementarymatrices/linspace.xml @@ -59,6 +59,7 @@ Examples diff --git a/scilab/modules/elementary_functions/help/en_US/elementarymatrices/logspace.xml b/scilab/modules/elementary_functions/help/en_US/elementarymatrices/logspace.xml index b801886..40d77a0 100644 --- a/scilab/modules/elementary_functions/help/en_US/elementarymatrices/logspace.xml +++ b/scilab/modules/elementary_functions/help/en_US/elementarymatrices/logspace.xml @@ -43,7 +43,7 @@ returns a row vector of n logarithmically equally spaced points between 10^{d1} and - 10^{d2}. If d2=%pi then the points are + 10^{d2}. If d2=\pi then the points are between 10^{d1} and \pi. @@ -51,6 +51,7 @@ Examples diff --git a/scilab/modules/elementary_functions/help/en_US/signalprocessing/trfmod.xml b/scilab/modules/elementary_functions/help/en_US/signalprocessing/trfmod.xml index 0d1971a..5247899 100644 --- a/scilab/modules/elementary_functions/help/en_US/signalprocessing/trfmod.xml +++ b/scilab/modules/elementary_functions/help/en_US/signalprocessing/trfmod.xml @@ -47,7 +47,7 @@ Examples Description mdelete may be used to delete a file or a set of files if - filename contains meta-charaters. + filename contains meta-characters. @@ -51,9 +51,8 @@ Examples diff --git a/scilab/modules/fileio/help/en_US/mopen.xml b/scilab/modules/fileio/help/en_US/mopen.xml index 8b948a3..c4cb586 100644 --- a/scilab/modules/fileio/help/en_US/mopen.xml +++ b/scilab/modules/fileio/help/en_US/mopen.xml @@ -220,6 +220,7 @@ + Examples - Examples flagexpand - optional boolean, used to expand leading variables in paths. - Only used with flag argument. Default value is true (%t). + optional boolean, used to expand leading + variables in paths. Only used with + flag argument. Default value + is true (%t). -- 1.7.9.5