Mercurial > octave
diff scripts/pkg/pkg.m @ 28713:28d2511f2af2 stable
maint: grammarcheck documentation ahead of 6.1 release.
* basics.txi, external.txi, file-io.cc, audiodevinfo.cc, ode15i.m, ode15s.m,
ode23.m, ode23s.m, ode45.m, pkg.m, get_inverse_dependencies.m, legend.m,
gui_mainfcn.m, hgtransform.m, __debug_octave__.m:
Grammarcheck documentation ahead of 6.1 release.
author | Rik <rik@octave.org> |
---|---|
date | Thu, 10 Sep 2020 14:28:33 -0700 |
parents | 6b964cf58ed4 |
children | d8dcb36bb904 |
line wrap: on
line diff
--- a/scripts/pkg/pkg.m Thu Sep 10 17:20:31 2020 -0400 +++ b/scripts/pkg/pkg.m Thu Sep 10 14:28:33 2020 -0700 @@ -29,18 +29,19 @@ ## @deftypefnx {} {[@var{out1}, @dots{}] =} pkg (@var{command}, @dots{} ) ## Manage or query packages (groups of add-on functions) for Octave. ## -## Packages can be installed globally (i.e. for all users of the system) or -## locally (i.e. for the current user only). +## Packages can be installed globally (i.e., for all users of the system) or +## locally (i.e., for the current user only). ## -## Global packages are by default installed in the "global packages store". -## That is usually located in a subdirectory of the folder where Octave itself -## is installed in. Therefore, Octave needs write access to this folder to -## install global packages. That usually means that Octave has to run with root -## access (or "Run as administrator") to be able to install packages globally. +## Global packages are installed by default in a system-wide location. This is +## usually a subdirectory of the folder where Octave itself is installed. +## Therefore, Octave needs write access to this folder to install global +## packages. That usually means that Octave has to run with root access (or +## "Run as administrator" on Windows) to be able to install packages globally. ## -## In contrast, local packages are by default installed in the user's profile -## and are only available to that specific user. Usually, they can be installed -## without root access (or administrative privileges). +## In contrast, local packages are installed by default in the user's +## home directory (profile on Windows) and are only available to that specific +## user. Usually, they can be installed without root access (or administrative +## privileges). ## ## For global and local packages, there are separate databases holding the ## information about the installed packages. If some package is installed @@ -63,12 +64,13 @@ ## @enumerate ## @item ## If the package depends on other packages (and @code{pkg load} is called -## without the @qcode{"-nodeps"} option), the package is not loaded immediately. -## Instead, those dependencies are loaded first (recursively if needed). +## without the @qcode{"-nodeps"} option), the package is not loaded +## immediately. Instead, those dependencies are loaded first (recursively if +## needed). ## ## @item -## When all dependencies are satified, the package's subdirectories are added to -## the search path. +## When all dependencies are satified, the package's subdirectories are +## added to the search path. ## @end enumerate ## ## This load order leads to functions that are provided by dependencies being @@ -79,9 +81,9 @@ ## for the package are automatically executed if they are provided by the ## package. ## -## Depending on the value of @var{command} and on the number of requested return -## arguments, @code{pkg} can be used to perform several tasks. Possible values -## for @var{command} are: +## Depending on the value of @var{command} and on the number of requested +## return arguments, @code{pkg} can be used to perform several tasks. +## Possible values for @var{command} are: ## ## @table @samp ## @@ -366,7 +368,7 @@ ## ## @item test ## Perform the built-in self tests contained in all functions provided by -## the named packages. For example, +## the named packages. For example: ## ## @example ## pkg test image