octave-bug-tracker
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[Octave-bug-tracker] [bug #34661] Confusing documentation for transpose


From: John W. Eaton
Subject: [Octave-bug-tracker] [bug #34661] Confusing documentation for transpose operator: `x.''
Date: Fri, 28 Oct 2011 17:46:12 +0000
User-agent: Mozilla/5.0 (X11; Linux x86_64; rv:6.0.2) Gecko/20100101 Firefox/6.0.2 Iceweasel/6.0.2

Follow-up Comment #7, bug #34661 (project octave):

I don't think there are any ASCII quoting characters that would be good and
have any less potential for confusion since most are used in the Octave
language in some way.

@verb would be OK visually, but that removes the @code info from the source. 
I prefer the idea of logical markup over visual if possible.

However you want to fix this, I think it might be best to define a Texinfo
macro in octave.texi so we can use something like @xcode{} in the sources. 
Then we can decide whether that should always use @verb or some @if
construct.

Rik, the fix would be in makeinfo, not texinfo.tex.  TeX already does
something reasonable by using a typewriter font.  It's only the Info output
that has trouble since it only outputs ASCII and can't give visual clues using
fonts.

I don't much like the idea of rewording things.  Saying "x-y expression" also
seems awkward to me.

How much effort do you want to put into solving this minor problem?  We have
real bugs to fix.

Also, I expect that eventually we won't care much about what the plain text
output looks like as we will probably be displaying help text in some better
way that will allow font differences to be used to give visual cues about
things like @code.

    _______________________________________________________

Reply to this item at:

  <http://savannah.gnu.org/bugs/?34661>

_______________________________________________
  Message sent via/by Savannah
  http://savannah.gnu.org/




reply via email to

[Prev in Thread] Current Thread [Next in Thread]