bugGNU Octave - Bugs: bug #52771, @ function handle operator does...

 
 

bug #52771: @ function handle operator does not have help entry

Submitted by:  Dan Sebald <sebald>
Submitted on:  Mon 01 Jan 2018 02:39:16 AM UTC  
 
Category:  Documentation Severity:  3 - Normal
Priority:  5 - Normal Item Group:  Documentation
Status:  Fixed Assigned to:  None
Originator Name:  Open/Closed:  Closed
Release:  dev Operating System:  Any

Add a New Comment(Rich Markup)
   

You are not logged in

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

 

Thu 04 Jan 2018 05:12:25 PM UTC, comment #5:

I pushed your cset here (http://hg.savannah.gnu.org/hgweb/octave/rev/a2569d574ae5). I decided to use @plus as the example because I thought it was even clearer. I also updated octave.texi to include the new sub-node you created. I've been wrapping all Octave text to 79+newline rather than 72 so I made that change as well.

Rik <rik5>
Project Administrator
Tue 02 Jan 2018 09:33:16 PM UTC, comment #4:

Oh, yeah ... I'll answer my own question about the utf8 character in op-kw-docs. Yesterday I messed around with Texinfo stuff. Looking through some files to get familiar with the doc processing, I recall the use of "utf8" in some Perl script:

i.e.,

I suppose op-kw-docs eventually finds its way to the above perl script.

Copying and pasting works fine in gvim (the character in question is a red-highlight ^] ). As an alternative, could have used some kind of encoding sequence.

https://en.wikibooks.org/wiki/Perl_Programming/Unicode_UTF-8

I'm fine with the utf8 character. Dealing with just one or two characters isn't difficult.

Dan Sebald <sebald>
Tue 02 Jan 2018 09:30:30 PM UTC, comment #3:

Updating the changeset. It's pretty much the same. I just changed "(class methods)" to "class methods" and "(function handle)" to "function handle" to be consistent with the changes I made yesterday for user-manual cleanup:

https://savannah.gnu.org/bugs/index.php?52772
https://savannah.gnu.org/bugs/index.php?52774

(file #42791)

Dan Sebald <sebald>
Mon 01 Jan 2018 10:48:38 AM UTC, comment #2:

I added some qualifiers so that the entries in the Operator Index appear as

Maybe that is preferred.

BTW, what is this character

in the op-kw-docs file. I would think that any kind of doc-layout system would want to use conventional ASCII characters only.

(file #42781)

Dan Sebald <sebald>
Mon 01 Jan 2018 03:05:20 AM UTC, comment #1:

Attached is a patch. After applying and compiling. Type

help @

or

help("@")

Also, in xreader or acroread look at the octave.pdf file for a new sub-section "Access via handle". Look at the very last page (or second-to-last) for the '@' symbol in the operator index. There should be a page number link to both the newly created node and also to the @directory-for-class-methods documentation.

(file #42776)

Dan Sebald <sebald>
Mon 01 Jan 2018 02:39:16 AM UTC, original submission:

There is no entry for "help @". Technically it isn't an operator, but since it is a single character, it seems best it be in the operator table. I'll add a changeset after creating a bug number.

Dan Sebald <sebald>

 

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

Attach Files:
   
   
Comment:
   

 

Depends on the following items: None found

Items that depend on this one: None found

 

Carbon-Copy List
  • -email is unavailable- added by rik5 (Posted a comment)
  • -email is unavailable- added by siko1056 (Updated the item)
  • -email is unavailable- added by sebald (Submitted the item)
  •  

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

    Only project members can vote.

     

     

     

    Follow 6 latest changes.

    Date Changed by Updated Field Previous Value => Replaced by
    2018-01-04 rik5 StatusPatch Submitted => Fixed
        Open/ClosedOpen => Closed
    2018-01-03 siko1056 StatusNone => Patch Submitted
    2018-01-02 sebald Attached File- => Added octave-function_handle_help-djs2018jan02.patch, #42791
    2018-01-01 sebald Attached File- => Added octave-function_handle_help-djs2018jan01.patch, #42781
    2018-01-01 sebald Attached File- => Added octave-function_handle_help-djs2017dec31.patch, #42776

    Back to the top


    Powered by Savane 3.3