bugGNU Octave - Bugs: bug #33434, Docs - doc/interpreter/io.texi fix

 
 

bug #33434: Docs - doc/interpreter/io.texi fix

Submitted by:  John Bradshaw <john_bradshaw>
Submitted on:  Mon 30 May 2011 09:32:02 PM UTC  
 
Category: NoneSeverity: 3 - Normal
Priority: 5 - NormalItem Group: Documentation
Status: Need InfoAssigned to: None
Originator Name: John BradshawOpen/Closed: Closed
Release: 3.4.0Operating System: Other

Add a New Comment(Rich Markup)
   

You are not logged in

Please log in, so followups can be emailed to you.

 

Mon 06 Jun 2011 04:26:18 PM UTC, comment #3:

This is okay. The .txi file has the text of the manual and then uses a macro, @DOCSTRING(function_name), to insert Texinfo documentation that is stored with the function. For example, in the instance you cite the .txi file contains:

The first sentence is copied directly from io.txi to io.texi. And in this case, the rest of the documentation comes from the Texinfo strings embedded with the functions in .m files. If you look a few lines above line #982 in io.texi you will find a comment line which identifies the function name and where the documentation came from. In this case,

Rik <rik5>
Project Administrator
Sun 05 Jun 2011 01:01:29 PM UTC, comment #2:

Got the heads-up about using txi files, thanks for that.

It appears that io.texi didn't cleanly produce from io.txt as the texi file contains "specifes" )line 982 but the txi file doesnt.

bash-3.2$ grep -nC5 specifes io.texi
977-@itemize
978-@item "headerlines":
979-@end itemize
980-The first @var{value} number of lines of @var{str} are skipped.
981-
982:The optional input, @var{n}, specifes the number of lines to be read from
983-the file, associated with @var{fid}.
984-
985-The output, @var{C}, is a cell array whose length is given by the number
986-of format specifiers.
987-

John Bradshaw <john_bradshaw>
Thu 02 Jun 2011 07:00:00 PM UTC, comment #1:

Was a patch file supposed to be attached to this report?

Rik <rik5>
Project Administrator
Mon 30 May 2011 09:32:02 PM UTC, original submission:

Small spelling fixes for doc/interpreter/io.texi

John Bradshaw <john_bradshaw>

 

(Note: upload size limit is set to 16384 kB, after insertion of the required escape characters.)

Attach File(s):
   
   
Comment:
   

No files currently attached

 

Depends on the following items: None found

Items that depend on this one: None found

 

Carbon-Copy List
  • -unavailable- added by rik5 (Posted a comment)
  • -unavailable- added by john_bradshaw (Submitted the item)
  •  

    Do you think this task is very important?
    If so, you can click here to add your encouragement to it.
    This task has 0 encouragements so far.

    Only project members can vote.

     

    Please enter the title of George Orwell's famous dystopian book (it's a date):

     

     

    Follow 2 latest changes.

    Date Changed By Updated Field Previous Value => Replaced By
    Mon 06 Jun 2011 04:26:18 PM UTCrik5Open/ClosedOpen=>Closed
    Sat 04 Jun 2011 02:37:52 PM UTCrik5StatusNone=>Need Info

    Back to the top


    Powered by Savane 3.1-cleanup1