[changeset] - doc string fix for reallog

[Ben Abbott]

I noticed the recently added regexptranslate.m's doc string is ...

    19## -*- texinfo -*-
    20## @deftypefn {Function File} {} realsqrt (@var{x})
    21## Return the real natural logarithm of @var{x}. If any element  
results in the
    22## return value being complex @code{reallog} produces an error.
    23## @seealso{log, realsqrt, realpow}
    24## @end deftypefn

Beyond the obvious, I notice the help text is quite inconsistent ...  
Looking at reallog.m

    19## -*- texinfo -*-
    20## @deftypefn {Function File} {} realsqrt (@var{x})
    21## Return the real natural logarithm of @var{x}. If any element  
results in the
    22## return value being complex @code{reallog} produces an error.
    23## @seealso{log, realsqrt, realpow}
    24## @end deftypefn

I've attached a changeset for reallog.m, but am unfamiliar with  
regexptranslate. Perhaps someone can submit a changeset for that  
function, or can recommend a doc string and I'll submit the changeset.

Ben




# HG changeset patch
# User Ben Abbott <bpabbott@...>
# Date 1216944971 14400
# Node ID ebf867d8c3fccca393d3e0dd5774b5c3849a7eb6
# Parent  dd5cc5016487f81a49b0f17a8127cdabc61a4c6c
Fix help string.

diff -r dd5cc5016487 -r ebf867d8c3fc scripts/ChangeLog
--- a/scripts/ChangeLog Thu Jul 24 15:42:40 2008 -0400
+++ b/scripts/ChangeLog Thu Jul 24 20:16:11 2008 -0400
@@ -1,3 +1,7 @@
[phone] Ben Abbott <bpabbott@...>
+
+ * specfun/reallog.m: Fix help string.
+
 2008-07-24  Ben Abbott  <bpabbott@...>
 
  * time/datestr.m: New xtest.
diff -r dd5cc5016487 -r ebf867d8c3fc scripts/specfun/reallog.m
--- a/scripts/specfun/reallog.m Thu Jul 24 15:42:40 2008 -0400
+++ b/scripts/specfun/reallog.m Thu Jul 24 20:16:11 2008 -0400
@@ -17,7 +17,7 @@
 ## <http://www.gnu.org/licenses/>.
 
 ## -*- texinfo -*-
-## @deftypefn {Function File} {} realsqrt (@var{x})
+## @deftypefn {Function File} {} reallog (@var{x})
 ## Return the real natural logarithm of @var{x}. If any element results in the
 ## return value being complex @code{reallog} produces an error.
 ## @seealso{log, realsqrt, realpow}

_______________________________________________
Bug-octave mailing list
Bug-octave@...
https://www.cae.wisc.edu/mailman/listinfo/bug-octave

[dbateman3]

Ben Abbott wrote:

> I noticed the recently added regexptranslate.m's doc string is ...
>
>    19## -*- texinfo -*-
>    20## @deftypefn {Function File} {} realsqrt (@var{x})
>    21## Return the real natural logarithm of @var{x}. If any element
> results in the
>    22## return value being complex @code{reallog} produces an error.
>    23## @seealso{log, realsqrt, realpow}
>    24## @end deftypefn
>
> Beyond the obvious, I notice the help text is quite inconsistent ...
> Looking at reallog.m
>
>    19## -*- texinfo -*-
>    20## @deftypefn {Function File} {} realsqrt (@var{x})
>    21## Return the real natural logarithm of @var{x}. If any element
> results in the
>    22## return value being complex @code{reallog} produces an error.
>    23## @seealso{log, realsqrt, realpow}
>    24## @end deftypefn
>
> I've attached a changeset for reallog.m, but am unfamiliar with
> regexptranslate. Perhaps someone can submit a changeset for that
> function, or can recommend a doc string and I'll submit the changeset.
>
> Ben
>

Opps, ok here is a changeset for regexptranslate

D.

# HG changeset patch
# User David Bateman <dbateman@...>
# Date 1217119377 -7200
# Node ID e9ca46fb5739dcdad349bf99b04d1830d32e2229
# Parent  595b089bb33a6684e2c45300b3394041fc48c6cf
Document regexptranslate

diff --git a/scripts/ChangeLog b/scripts/ChangeLog
--- a/scripts/ChangeLog
+++ b/scripts/ChangeLog
@@ -1,5 +1,7 @@ 2008-07-27  David Bateman  <dbateman@fre
 2008-07-27  David Bateman  <dbateman@...>
 
+ * strings/regexptranslate.m: Add real documentation.
+
  * plot/contourf.m: Allow X,Y to be unequal vectors.
 
  * control, finance, quaternion: Remove directories and all of the
diff --git a/scripts/strings/regexptranslate.m b/scripts/strings/regexptranslate.m
--- a/scripts/strings/regexptranslate.m
+++ b/scripts/strings/regexptranslate.m
@@ -17,10 +17,21 @@
 ## <http://www.gnu.org/licenses/>.
 
 ## -*- texinfo -*-
-## @deftypefn {Function File} {} realsqrt (@var{x})
-## Return the real natural logarithm of @var{x}. If any element results in the
-## return value being complex @code{reallog} produces an error.
-## @seealso{log, realsqrt, realpow}
+## @deftypefn {Function File} {} regexptranslate (@var{op}, @var{s})
+## Translate a string for use in a regular expression. This might
+## include either wildcard replacement or special character escaping.
+## The behavior can be controlled by the @var{op} that can have the
+## values
+##
+## @table @asis
+## @item "wildcard"
+## The wildcard characters @code{.}, @code{*} and @code{?} are replaced
+## with wildcards that are appropriate for a regular expression.
+##
+## @item "escape"
+## The characters @code{$.?[]}, that have special meaning for regular
+## expressions are escaped so that they are treated literally.
+## @end table
 ## @end deftypefn
 
 function y = regexptranslate (op, x)

_______________________________________________
Bug-octave mailing list
Bug-octave@...
https://www.cae.wisc.edu/mailman/listinfo/bug-octave

[John W. Eaton]

On 27-Jul-2008, David Bateman wrote:

| Ben Abbott wrote:
| > I noticed the recently added regexptranslate.m's doc string is ...
| >
| >    19## -*- texinfo -*-
| >    20## @deftypefn {Function File} {} realsqrt (@var{x})
| >    21## Return the real natural logarithm of @var{x}. If any element
| > results in the
| >    22## return value being complex @code{reallog} produces an error.
| >    23## @seealso{log, realsqrt, realpow}
| >    24## @end deftypefn
| >
| > Beyond the obvious, I notice the help text is quite inconsistent ...
| > Looking at reallog.m
| >
| >    19## -*- texinfo -*-
| >    20## @deftypefn {Function File} {} realsqrt (@var{x})
| >    21## Return the real natural logarithm of @var{x}. If any element
| > results in the
| >    22## return value being complex @code{reallog} produces an error.
| >    23## @seealso{log, realsqrt, realpow}
| >    24## @end deftypefn
| >
| > I've attached a changeset for reallog.m, but am unfamiliar with
| > regexptranslate. Perhaps someone can submit a changeset for that
| > function, or can recommend a doc string and I'll submit the changeset.
| >
| > Ben
| >
|
| Opps, ok here is a changeset for regexptranslate

I applied it.

Thanks,

jwe
_______________________________________________
Bug-octave mailing list
Bug-octave@...
https://www.cae.wisc.edu/mailman/listinfo/bug-octave

[dbateman]

John W. Eaton wrote:

I applied it.

I think you need to apply Ben's as well.

Cheers
D.

[John W. Eaton]

On 24-Jul-2008, Ben Abbott wrote:

| I noticed the recently added regexptranslate.m's doc string is ...
|
|     19## -*- texinfo -*-
|     20## @deftypefn {Function File} {} realsqrt (@var{x})
|     21## Return the real natural logarithm of @var{x}. If any element  
| results in the
|     22## return value being complex @code{reallog} produces an error.
|     23## @seealso{log, realsqrt, realpow}
|     24## @end deftypefn
|
| Beyond the obvious, I notice the help text is quite inconsistent ...  
| Looking at reallog.m
|
|     19## -*- texinfo -*-
|     20## @deftypefn {Function File} {} realsqrt (@var{x})
|     21## Return the real natural logarithm of @var{x}. If any element  
| results in the
|     22## return value being complex @code{reallog} produces an error.
|     23## @seealso{log, realsqrt, realpow}
|     24## @end deftypefn
|
| I've attached a changeset for reallog.m,

I applied it.

Thanks,

jwe


_______________________________________________
Bug-octave mailing list
Bug-octave@...
https://www.cae.wisc.edu/mailman/listinfo/bug-octave

[John W. Eaton]

On 28-Jul-2008, dbateman wrote:

| John W. Eaton wrote:
| >
| > I applied it.
| >
|
| I think you need to apply Ben's as well.

Done.

Thanks,

jwe
_______________________________________________
Bug-octave mailing list
Bug-octave@...
https://www.cae.wisc.edu/mailman/listinfo/bug-octave