changeset 33091:6ed312edd0d4 stable

doc: Add PCRE reference link to regexp docstring (bug #39431) * libinterp/corefcn/regexp.cc (regexp): Add note to the end of docstring linking out to the PCRE documentaiton pages for a full syntax reference.
author Nicholas R. Jankowski <jankowski.nicholas@gmail.com>
date Mon, 26 Feb 2024 23:28:09 -0500
parents 2239226e99d1
children 6c44d6d505f5 dbf49a4f50da
files libinterp/corefcn/regexp.cc
diffstat 1 files changed, 7 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/libinterp/corefcn/regexp.cc	Fri Feb 23 15:11:57 2024 -0500
+++ b/libinterp/corefcn/regexp.cc	Mon Feb 26 23:28:09 2024 -0500
@@ -880,6 +880,13 @@
 searches that reduce the number of matches (e.g., by creatively using set
 complement), and then further processing the return variables (now reduced in
 size) with successive @code{regexp} searches.
+
+Octave's @code{regexp} implementaion is based on the Perl Compatible Regular 
+Expressions library (@url{https://www.pcre.org/}).  For a more comprehensive list
+of rexexp operator syntax see the 
+@url{https://www.pcre.org/current/doc/html/pcre2syntax.html,,
+"PCRE Syntax quick-reference summary"}.
+
 @seealso{regexpi, strfind, regexprep}
 @end deftypefn */)
 {