[Octave-bug-tracker] [bug #57085] [io] Comment notes in helptext examples?

[Andrew Janke]

URL:
  <https://savannah.gnu.org/bugs/?57085>

                 Summary: [io] Comment notes in helptext examples?
                 Project: GNU Octave
            Submitted by: apjanke
            Submitted on: Sat 19 Oct 2019 05:47:25 PM EDT
                Category: Octave Forge Package
                Severity: 3 - Normal
                Priority: 5 - Normal
              Item Group: Documentation
                  Status: None
             Assigned to: None
         Originator Name: 
        Originator Email: 
             Open/Closed: Open
         Discussion Lock: Any
                 Release: other
        Operating System: Any

    _______________________________________________________

Details:

In the io package, in the function helptext, examples are formatted like
this:


     Examples:

            A = xls2oct (xls1, '2nd_sheet', 'C3:AB40');
            (which returns the numeric contents in range C3:AB40 in worksheet
            '2nd_sheet' from a spreadsheet file pointed to in pointer struct
xls1,
            into numeric array A)

            [An, xls2, status] = xls2oct (xls2, 'Third_sheet');


Plain prose is mixed in with code. What do you think about reformatting them
as comments inside the examples? Like this:


     Examples:

            # returns the numeric contents in range C3:AB40 in worksheet
            # '2nd_sheet' from a spreadsheet file pointed to in pointer struct
xls1,
            # into numeric array A
            A = xls2oct (xls1, '2nd_sheet', 'C3:AB40');

            [An, xls2, status] = xls2oct (xls2, 'Third_sheet');


Might help with readability, and then you can highlight multiple lines worth
of example code and "Run selection", and it'll wok.




    _______________________________________________________

Reply to this item at:

  <https://savannah.gnu.org/bugs/?57085>

_______________________________________________
  Message sent via Savannah
  https://savannah.gnu.org/