bugGNU Octave - Bugs: bug #47309, clarify options for csvread and...

 
 

bug #47309: clarify options for csvread and write

Submitted by:  Nicholas Jankowski <nrjank>
Submitted on:  Mon 29 Feb 2016 05:32:27 PM UTC  
 
Category: DocumentationSeverity: 3 - Normal
Priority: 5 - NormalItem Group: Documentation
Status: FixedAssigned to: None
Originator Name: Nicholas JankowskiOpen/Closed: Closed
Release: 4.0.0Operating System: Any

Add a New Comment(Rich Markup)
   

You are not logged in

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

 

Tue 01 Mar 2016 05:12:57 PM UTC, comment #4:

I changed the wording, but followed your lead in this cset (http://hg.savannah.gnu.org/hgweb/octave/rev/c9f967cfe7c1). Fixed, and closing report.

Rik <rik5>
Project Administrator
Mon 29 Feb 2016 06:38:36 PM UTC, comment #3:

was just looking for the @code command. hg working here now, too. patch attached.

(file #36510)

Nicholas Jankowski <nrjank>
Mon 29 Feb 2016 06:12:53 PM UTC, comment #2:

Yes I think referring to the other functions for the full set of options is a good choice. See how it's done in e.g. printf, sprintf, fprintf (libinterp/corefcn/file-io.cc).

Also use

to markup references to other Octave functions.

(hg seems to be working for me now)

Mike Miller <mtmiller>
Project Administrator
Mon 29 Feb 2016 05:52:58 PM UTC, comment #1:

I seem to be unable to pull from mercurial repo at the moment, so don't have the latest version of csvread and write to edit. (I see bug 46248 has push a change to them https://savannah.gnu.org/bugs/?46248 ) Here's the patch text I'll add when I sort things out, unless someone else gets it first:

csvread.m, just before the seealso:

csvwrite.m, just before the seealso:

Nicholas Jankowski <nrjank>
Mon 29 Feb 2016 05:32:27 PM UTC, original submission:

from the help mailing list, user was unclear what options could be pushed to csvread and csvwrite. as these are just wrappers for dlmread and write (simply passing the arguments with ',' specified), the options are the same as those for dlmwrite.

will make a simple doc patch to clarify. Unless anyone objects I think just referring the user to dlmread/write would be sufficient so that if things ever change with the dlm functions the csv docs don't need to be changed.

Nicholas Jankowski <nrjank>

 

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

Attach File(s):
   
   
Comment:
   

Attached Files
file #36510:  csv_docnote.diff added by nrjank (2KiB - application/octet-stream - documentation patch for both files)

 

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 mtmiller (Posted a comment)
  • -unavailable- added by nrjank (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 4 latest changes.

    Date Changed By Updated Field Previous Value => Replaced By
    Tue 01 Mar 2016 05:12:57 PM UTCrik5StatusNone=>Fixed
      Open/ClosedOpen=>Closed
    Mon 29 Feb 2016 06:38:36 PM UTCnrjankAttached File-=>Added csv_docnote.diff, #36510
    Mon 29 Feb 2016 06:12:53 PM UTCmtmillerItem GroupOther=>Documentation

    Back to the top


    Powered by Savane 3.1-cleanup1