bugGNU Octave - Bugs: bug #65253, [octave forge] (signal) Wrong TeX...

 
 

bug #65253: [octave forge] (signal) Wrong TeX fragment in documentation string of xcorr

Submitter:  Rafael Laboissière <rlaboiss>
Submitted:  Sun 04 Feb 2024 04:00:20 PM UTC
   
 
Category:  Octave Forge Package Severity:  3 - Normal
Priority:  5 - Normal Item Group:  Documentation
Status:  Ready For Test Assigned to:  lostbard
Originator Name:  Open/Closed:  * Open
Release:  * other Operating System:  * Any
Fixed Release:  None Planned Release:  None
* Mandatory Fields

Add a New Comment Rich Markup
   

Tue 06 Feb 2024 04:52:27 PM UTC, comment #3: 

I pushed up this patch and one for couple of other issues that were stopping pdf build for me.

John Donoghue <lostbard>
Group Member
Tue 06 Feb 2024 03:08:55 PM UTC, comment #2: 

I think there may also be other issues with pdf generation in the signal package.


With the checked out repo, running make doc, to ensure I have the generated files and then from the doc filder running

texi2pdf signal.texi


[2] (/home/jade/octave-packages/octave-signal/doc/functions.texi
Writing index file signal.fn

Overfull \hbox (24.7901pt too wide) in paragraph at lines 85--85
 [] @texttt specgram (chirp ([0:0.001:5]));  # default linear chirp of 0-100Hz
in 1 sec[]
/home/jade/octave-packages/octave-signal/doc/functions.texi:93: @group invalid
in context where filling is enabled.
@group ...lid in context where filling is enabled}
                                                  @fi @startsavinginserts @s...
l.93 @group

?
/home/jade/octave-packages/octave-signal/doc/functions.texi:93: Emergency stop.

@group ...lid in context where filling is enabled}
                                                  @fi @startsavinginserts @s...
l.93 @group

/home/jade/octave-packages/octave-signal/doc/functions.texi:93:  ==> Fatal error occurred, no output PDF file produced!


I will take a look at what else isnt working

John Donoghue <lostbard>
Group Member
Sun 04 Feb 2024 05:15:30 PM UTC, comment #1: 

I don't have a handy way of verifying that it breaks pdf rendering, but at least any latex eqn rendered i use just ignores the \conj entirely and displays a plain yi.  Marking as confirmed and tagging package maintainer.

Nicholas Jankowski <nrjank>
Group Member
Sun 04 Feb 2024 04:00:20 PM UTC, original submission:  

In file inst/xcorr.m, we see the following:


## @tex
## $$   R_{xy}(k) = \sum_{i=1}^{N} x_{i+k} \conj(y_i),
## @end tex


I think it should be:


## @tex
## $$   R_{xy}(k) = \sum_{i=1}^{N} x_{i+k} \overline{y_i}, $$
## @end tex


The \conj command does not exist in TeX. The appropriate way of representing the conjugation in TeX is by using the \overline macro.
 
Furthermore, the closing tag $$ is lacking.

The patch attached to this bug report fixes the problem. Withoout applying it, it is not possible to build the PDF form of documentation for the package.

Rafael Laboissière <rlaboiss>

 

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

Attach Files:
   
   
Comment:
   

Attached Files

 

Depends on the following items: None found

Items that depend on this one: None found

 

Carbon-Copy List
  • -email is unavailable- added by lostbard (Posted a comment)
  • -email is unavailable- added by nrjank (Posted a comment)
  • -email is unavailable- added by nrjank
  • -email is unavailable- added by rlaboiss (Submitted the item)
  •  

    There are 0 votes so far. Votes easily highlight which items people would like to see resolved in priority, independently of the priority of the item set by tracker managers.

    Only group members can vote.

     

    Follow 5 latest changes.

    Date Changed by Updated Field Previous Value => Replaced by
    2024-02-06 lostbard StatusConfirmed Ready For Test
        Assigned toNone lostbard
    2024-02-04 nrjank StatusNone Confirmed
        Carbon-Copy- Added -email is unavailable-
    2024-02-04 rlaboiss Attached File- Added xcorr-doc-conjugation.patch, #55666

    Back to the top

    Powered by Savane 3.12.
    Corresponding source code