how to correct/patch documentation?
Ben Abbott
bpabbott at mac.com
Mon Feb 18 12:55:41 CST 2008
On Feb 18, 2008, at 1:28 PM, John W. Eaton wrote:
> On 18-Feb-2008, Ben Abbott wrote:
>
> |
> | On Feb 18, 2008, at 12:35 PM, John W. Eaton wrote:
> |
> | > On 18-Feb-2008, Ben Abbott wrote:
> | >
> | > | I was browsing the on-line documentation and noticed a reference
> | > to a
> | > | deprecated function, "struct_elements".
> | > |
> | > | http://www.gnu.org/software/octave/doc/interpreter/Error-Messages.html#Error-Messages
> | > |
> | > | struct_elements ([1, 2; 3, 4])
> | > | error: struct_elements: wrong type argument `matrix'
> | > | What is the proper method to have it changed to "fieldnames" ?
> | > | fieldnames ([1, 2; 3, 4])
> | > | error: fieldnames: wrong type argument `matrix'
> | >
> | > Submit a patch for the documentation in Octave's sources.
> Eventually
> | > a new version of the manual will be pushed to the web site,
> probably
> | > when the next stable version of Octave is released. For updates
> to
> | > happen any more frequently that that, we will need some active
> | > volunteers to manage the web site as I can no longer keep up.
> | >
> | > jwe
> |
> | ... unfortunately, I can't find this instance in the documentation
> | included with the sources. Is it not there, or lacking in my attempt
> | to find it?
>
> I think
>
> cd doc/interpreter
> grep struct_elements *.txi
>
> should find it.
>
> jwe
Thanks John,
For some reason, my Mac OSX doesn't index the contents of *.txi
files :-(
In any event, I've attached a diff and ChangeLog. I'd become
accustomed to generating patches "cvs diff -u ...". If the diff I've
created against my local copy isn't quite what is desired, let me know.
2008-01-18 Ben Abbott <bpabbott at mac.com>
* doc/interpreter/intro.txi: Replaced reference to deprecated
function struct_elements with filenames.
--- /Users/bpabbott/Development/mercurial/octave/doc/interpreter/
intro.txi 2008-02-10 00:35:45.000000000 -0500
+++ intro.txi 2008-02-18 13:36:44.000000000 -0500
@@ -454,8 +454,8 @@
@example
@group
-struct_elements ([1, 2; 3, 4])
-error: struct_elements: wrong type argument `matrix'
+fieldnames ([1, 2; 3, 4])
+error: fieldnames: wrong type argument `matrix'
@end group
@end example
Ben
-------------- next part --------------
A non-text attachment was scrubbed...
Name: intro.diff
Type: application/octet-stream
Size: 391 bytes
Desc: not available
Url : https://www.cae.wisc.edu/pipermail/bug-octave/attachments/20080218/698cb46f/attachment.obj
-------------- next part --------------
-------------- next part --------------
A non-text attachment was scrubbed...
Name: ChangeLog
Type: application/octet-stream
Size: 152 bytes
Desc: not available
Url : https://www.cae.wisc.edu/pipermail/bug-octave/attachments/20080218/698cb46f/attachment-0001.obj
-------------- next part --------------
More information about the Bug-octave
mailing list