bugGNU Octave - Bugs: bug #55209, DOCSTRING macro does not recognize...

 
 

bug #55209: DOCSTRING macro does not recognize matlab.lang.makeValidName

Submitted by:  Rik <rik5>
Submitted on:  Tue 11 Dec 2018 11:24:44 PM UTC  
 
Category:  Documentation Severity:  3 - Normal
Priority:  5 - Normal Item Group:  Build Failure
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 13 Dec 2018 05:22:33 PM UTC, comment #5: 

This was easy to fix.  See this cset https://hg.savannah.gnu.org/hgweb/octave/rev/52a595c996bc.

Rik <rik5>
Project Administrator
Thu 13 Dec 2018 05:15:24 PM UTC, comment #4: 

It does print a warning, but if I try the hyperlinks in octave.pdf they still work.

The @ref structure that we use is

@ref{node_name, , printed_name}

Just for fun, I replaced the '.' character with an underscore in the node name in var.texi.

@ref{XREFmatlab_lang_makeUniqueStrings,,matlab.lang.makeUniqueStrings}}

This gets rid of the warning.  The only thing is that the @anchor command also has to change.

@anchor{XREFmatlab_lang_makeUniqueStrings}

Rik <rik5>
Project Administrator
Thu 13 Dec 2018 10:50:35 AM UTC, comment #3: 

I see a couple of warnings when building the documentation:

doc/interpreter/var.texi:136: warning: @ref node name should not contain `.' (possibly involving @seealso)
doc/interpreter/var.texi:170: warning: @ref node name should not contain `.' (possibly involving @seealso)

corresponding to:

@seealso{@ref{XREFiskeyword,,iskeyword}, @ref{XREFisvarname,,isvarname}, @ref{XREFmatlab.lang.makeUniqueStrings,,matlab.lang.makeUniqueStrings}}

Guillaume <gyom>
Thu 13 Dec 2018 04:55:50 AM UTC, comment #2: 

Works fine.  Closing report.

Rik <rik5>
Project Administrator
Thu 13 Dec 2018 03:04:59 AM UTC, comment #1: 
John W. Eaton <jwe>
Project Administrator
Tue 11 Dec 2018 11:24:44 PM UTC, original submission:  

Seems to be a general problem that a dotted function name like the one in the Bug Summary can not be put in to the Octave manual with

@DOCSTRING(matlab.lang.makeValidName)

Rik <rik5>
Project Administrator

 

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

Attach Files:
   
   
Comment:
   

No files currently attached

 

Depends on the following items: None found

Items that depend on this one: None found

 

Carbon-Copy List
  • -email is unavailable- added by gyom (Posted a comment)
  • -email is unavailable- added by jwe (Posted a comment)
  • -email is unavailable- added by rik5 (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 3 latest changes.

    Date Changed by Updated Field Previous Value => Replaced by
    2018-12-13 rik5 StatusReady For Test => Fixed
        Open/ClosedOpen => Closed
    2018-12-13 jwe StatusConfirmed => Ready For Test

    Back to the top


    Powered by Savane 3.5