Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

"See also" help is doubling all the @ signs #1288

Open
cbm755 opened this issue Jan 29, 2024 · 3 comments
Open

"See also" help is doubling all the @ signs #1288

cbm755 opened this issue Jan 29, 2024 · 3 comments
Milestone

Comments

@cbm755
Copy link
Collaborator

cbm755 commented Jan 29, 2024

See also: syms, assumptions, @@sym/assume, @@sym/assumeAlso.

Code looks like:

%% @seealso{@@sym/ellipticK, @@sym/ellipticE, @@sym/ellipticPi}

I thought it had to be like that to escape the @ command in texinfo... maybe it changed...?

@cbm755
Copy link
Collaborator Author

cbm755 commented Jan 29, 2024

They need doubled in Octave 5.2.2 on Ubuntu 20.04, where

makeinfo --version
texi2any (GNU texinfo) 6.7

@cbm755
Copy link
Collaborator Author

cbm755 commented Jan 29, 2024

My Fedora 39 system has:

makeinfo --version
texi2any (GNU texinfo) 7.0.3

In the Octave source, I found this change:

Author: Rik <rik@octave.org>
Date:   Wed Dec 29 08:41:33 2021 -0800

    doc: Allow links to old-style class files (@class/) in Texinfo @seealso macro.
    
    * mk-doc-cache.pl: Replace '@' with '@@' when expanding @seealso macro to
    @xseealso macro.  Also, many code formatting tweaks for clarity.
    
    * __makeinfo__.m: Replace '@' with '@@' when expanding @seealso macro to
    @xseealso macro.

@cbm755
Copy link
Collaborator Author

cbm755 commented Jan 29, 2024

Seems this was for 8.1.0, so probably we should change everything... Older Octave's will see this kind of warning:

>>> help @sym/ellipticF
/tmp/octave-help-yKmv1e:197: unknown command `sym' (possibly involving @xseealso)
/tmp/octave-help-yKmv1e:197: unknown command `sym' (possibly involving @xseealso)
warning: help: Texinfo formatting filter exited abnormally; raw Texinfo source of help text follows...
'@sym/ellipticF' is a function from the file /mnt/@sym/ellipticF.m

The alternative is to nudge upstream to support help sym.ellipticF so we don't have to do this change more than once. And just leave the double @@ in the official docs (or use Octave 7.3.0 to generate them).

@cbm755 cbm755 added this to the 3.3.0 milestone Jan 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant