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

[Rafael Laboissière]

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

                 Summary: [octave forge] (signal) Wrong TeX fragment in
documentation string of xcorr
                   Group: GNU Octave
               Submitter: 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: None
             Assigned to: None
         Originator Name: 
        Originator Email: 
             Open/Closed: Open
                 Release: other
         Discussion Lock: Any
        Operating System: Any
           Fixed Release: None
         Planned Release: None


    _______________________________________________________

Follow-up Comments:


-------------------------------------------------------
Date: Sun 04 Feb 2024 04:00:20 PM UTC By: Rafael Laboissière <rlaboiss>
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.






    _______________________________________________________
File Attachments:


-------------------------------------------------------
Name: xcorr-doc-conjugation.patch  Size: 564B
<http://savannah.gnu.org/bugs/download.php?file_id=55666>

    AGPL NOTICE

These attachments are served by Savane. You can download the corresponding
source code of Savane at
https://git.savannah.nongnu.org/cgit/administration/savane.git/snapshot/savane-7984227a52b1c59ed77ba5c9f7ef631497509617.tar.gz

    _______________________________________________________

Reply to this item at:

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

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