# HG changeset patch # User Rik # Date 1393740299 28800 # Node ID f51c1498b9f38e4d914eeeac3e458f56681f9737 # Parent ea0d4dea1a170b063b34ea817cae2c0e241bb161 doc: Replace "builtin" with "built-in" for consistency and correctness. * external.txi, func.txi, testfun.txi, doc_cache_create.m: Replace "builtin" with "built-in" for consistency and correctness. diff -r ea0d4dea1a17 -r f51c1498b9f3 doc/interpreter/external.txi --- a/doc/interpreter/external.txi Sat Mar 01 21:50:13 2014 -0800 +++ b/doc/interpreter/external.txi Sat Mar 01 22:04:59 2014 -0800 @@ -1759,7 +1759,7 @@ Note that the application @code{standalone} will be dynamically linked against the Octave libraries and any Octave support libraries. The above allows the Octave math libraries to be used by an application. It does -not, however, allow the script files, oct-files, or builtin functions of +not, however, allow the script files, oct-files, or built-in functions of Octave to be used by the application. To do that the Octave interpreter needs to be initialized first. An example of how to do this can then be seen in the code @@ -1780,17 +1780,17 @@ @end group @end example -It is worth noting that, if only builtin functions are to be called from +It is worth noting that, if only built-in functions are to be called from a C++ standalone program, then it does not need to initialize the -interpreter to do so. The general rule is that, for a builtin +interpreter to do so. The general rule is that, for a built-in function named @code{function_name} in the interpreter, there will be a C++ function named @code{Ffunction_name} (note the prepended capital -@code{F}) accessible in the C++ API@. The declarations for all builtin +@code{F}) accessible in the C++ API@. The declarations for all built-in functions are collected in the header file @code{builtin-defun-decls.h}. This feature should be used with care as the list of built-in functions can change. No guarantees can be made that a function that is currently built in won't be implemented as a .m file or as a dynamically linked function in the -future. An example of how to call builtin functions from C++ can be seen in the +future. An example of how to call built-in functions from C++ can be seen in the code @example diff -r ea0d4dea1a17 -r f51c1498b9f3 doc/interpreter/func.txi --- a/doc/interpreter/func.txi Sat Mar 01 21:50:13 2014 -0800 +++ b/doc/interpreter/func.txi Sat Mar 01 22:04:59 2014 -0800 @@ -1146,8 +1146,8 @@ between these versions are in that order. @item Built-in function -A function that is builtin to Octave itself such as @code{numel}, -@code{size}, etc. +A function that is a part of core Octave such as @code{numel}, @code{size}, +etc. @end enumerate @node Script Files diff -r ea0d4dea1a17 -r f51c1498b9f3 doc/interpreter/testfun.txi --- a/doc/interpreter/testfun.txi Sat Mar 01 21:50:13 2014 -0800 +++ b/doc/interpreter/testfun.txi Sat Mar 01 22:04:59 2014 -0800 @@ -365,8 +365,8 @@ shorthand for @code{%!test assert (x, y, tol)} @end table -You can also create test scripts for builtins and your own C++ -functions. To do so put a file with the bare function name (no .m +You can also create test scripts for built-in functions and your own C++ +functions. To do so, put a file with the bare function name (no .m extension) in a directory in the load path and it will be discovered by the @code{test} function. Alternatively, you can embed tests directly in your C++ code: diff -r ea0d4dea1a17 -r f51c1498b9f3 scripts/help/doc_cache_create.m --- a/scripts/help/doc_cache_create.m Sat Mar 01 21:50:13 2014 -0800 +++ b/scripts/help/doc_cache_create.m Sat Mar 01 22:04:59 2014 -0800 @@ -25,7 +25,7 @@ ## resulting cache is saved in the file @var{out_file}. ## The cache is used to speed up @code{lookfor}. ## -## If no directory is given (or it is the empty matrix), a cache for builtin +## If no directory is given (or it is the empty matrix), a cache for built-in ## operators, etc. is generated. ## ## @seealso{doc_cache_file, lookfor, path}