Mercurial > octave
changeset 29668:f17b1f0141ed stable
doc: Grammarcheck documentation ahead of 6.3 release.
* basics.txi, func.txi, plot.txi, help.cc, area.m, stairs.m,
subplot.m: Grammarcheck documentation ahead of 6.3 release.
| author | Rik <rik@octave.org> |
|---|---|
| date | Fri, 14 May 2021 14:22:59 -0700 |
| parents | 2a1f57067fbf |
| children | 101d1d8df273 |
| files | doc/interpreter/basics.txi doc/interpreter/func.txi doc/interpreter/plot.txi libinterp/corefcn/help.cc scripts/plot/draw/area.m scripts/plot/draw/stairs.m scripts/plot/util/subplot.m |
| diffstat | 7 files changed, 16 insertions(+), 13 deletions(-) [+] |
line wrap: on
line diff
--- a/doc/interpreter/basics.txi Thu May 13 17:14:54 2021 -0700 +++ b/doc/interpreter/basics.txi Fri May 14 14:22:59 2021 -0700 @@ -1079,7 +1079,7 @@ To write m-files that can act as executable programs when called from the shell or as normal functions when called from within Octave, use default input -arguments initialized with the @code{argv} function. +arguments initialized with the @code{argv} function. If a function is called from the shell Octave will not pass any input parameters to the function and therefore the default argument is used. But @@ -1109,6 +1109,7 @@ mysin.m 1.5 @end example +@noindent or from Octave with @example
--- a/doc/interpreter/func.txi Thu May 13 17:14:54 2021 -0700 +++ b/doc/interpreter/func.txi Fri May 14 14:22:59 2021 -0700 @@ -1921,6 +1921,7 @@ If an argument including spaces should be passed to a function in command syntax, (double-)quotes can be used. For example, + @example my_command "first argument" "second argument" @end example
--- a/doc/interpreter/plot.txi Thu May 13 17:14:54 2021 -0700 +++ b/doc/interpreter/plot.txi Fri May 14 14:22:59 2021 -0700 @@ -2719,15 +2719,15 @@ @code{datestruct}, and @code{datetick} functions. Serial dates encode timestamps as days elapsed since the year zero with hours, -minutes, seconds as the fractional part. On December 31st 1999, the serial date -representation was 730485. A double precision variable with this integer part -allows for a resolution in its fractional part of 1.2e-10, representing about 5 -microseconds. But with single precision, the resolution is reduced to about -0.06, representing 45 minutes. Any attempt to plot timestamped data with finer -granularity will result in a distorted graph. +minutes, seconds as the fractional part. On December 31st 1999, the serial +date representation was 730485. A double precision variable with this integer +part allows for a resolution in its fractional part of 1.2e-10, representing +about 5 microseconds. But with single precision, the resolution is reduced to +about 0.06, representing 45 minutes. Any attempt to plot timestamped data +with finer granularity will result in a distorted graph. As a workaround, it is possible to use the @qcode{"gnuplot"} graphics toolkit -or subtract 2000 years---i.e. @code{datenum (2000, 0, 0)} or 730485---from the +or subtract 2000 years---i.e., @code{datenum (2000, 0, 0)} or 730485---from the time values. Due to the fact that the calendar structure repeats every 2000 years, the relation between year, month, day of month and day of week will stay unchanged and the ticks and ticklabels produced by the @code{datetick} function
--- a/libinterp/corefcn/help.cc Thu May 13 17:14:54 2021 -0700 +++ b/libinterp/corefcn/help.cc Fri May 14 14:22:59 2021 -0700 @@ -1024,9 +1024,9 @@ Query or set the internal variable that specifies the name of the info program to run. -The default value is "@file{info}". The default value may be overridden by the -environment variable @w{@env{OCTAVE_INFO_PROGRAM}}, or the command line -argument @option{--info-program NAME}. +The default value is @file{info}. The default value may be +overridden by the environment variable @w{@env{OCTAVE_INFO_PROGRAM}}, or the +command line argument @option{--info-program NAME}. When called from inside a function with the @qcode{"local"} option, the variable is changed locally for the function and any subroutines it calls.
--- a/scripts/plot/draw/area.m Thu May 13 17:14:54 2021 -0700 +++ b/scripts/plot/draw/area.m Fri May 14 14:22:59 2021 -0700 @@ -41,7 +41,7 @@ ## the shading under the curve should be defined. The default level is 0. ## ## Additional property/value pairs are passed directly to the underlying patch -## object. The full list of properties is documented at +## object. The full list of properties is documented at ## @ref{Patch Properties}. ## ## If the first argument @var{hax} is an axes handle, then plot into this axes,
--- a/scripts/plot/draw/stairs.m Thu May 13 17:14:54 2021 -0700 +++ b/scripts/plot/draw/stairs.m Fri May 14 14:22:59 2021 -0700 @@ -42,7 +42,7 @@ ## of the same format as the @code{plot} command. ## ## Multiple property/value pairs may be specified, but they must appear in -## pairs. The full list of properties is documented at +## pairs. The full list of properties is documented at ## @ref{Line Properties}. ## ## If the first argument @var{hax} is an axes handle, then plot into this axes,