Mercurial > octave
changeset 24513:e61e26d1ede9
doc: Improve documentation for genpath().
* load-path.cc (Fgenpath): Improve docstring by mentioning which
file folders are excluded from generated path.
| author | Rik <rik@octave.org> |
|---|---|
| date | Thu, 04 Jan 2018 09:52:07 -0800 |
| parents | 3fc1c8ebe5c3 |
| children | 2bee24503a13 |
| files | libinterp/corefcn/load-path.cc |
| diffstat | 1 files changed, 5 insertions(+), 0 deletions(-) [+] |
line wrap: on
line diff
--- a/libinterp/corefcn/load-path.cc Thu Jan 04 09:40:23 2018 -0800 +++ b/libinterp/corefcn/load-path.cc Thu Jan 04 09:52:07 2018 -0800 @@ -2178,8 +2178,13 @@ @deftypefnx {} {} genpath (@var{dir}, @var{skip}, @dots{}) Return a path constructed from @var{dir} and all its subdirectories. +The path does not include package directories (beginning with @samp{+}), +old-style class directories (beginning with @samp{@@}), @file{private} +directories, or any subdirectories of these types. + If additional string parameters are given, the resulting path will exclude directories with those names. +@seealso{path, addpath} @end deftypefn */) { int nargin = args.length ();