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

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

[Octave-bug-tracker] [bug #62417] 'format' errors on names with spaces w


From: Rik
Subject: [Octave-bug-tracker] [bug #62417] 'format' errors on names with spaces when calling with function form
Date: Wed, 11 May 2022 13:45:21 -0400 (EDT)

Follow-up Comment #24, bug #62417 (project octave):

I think we are using Texinfo tags appropriately.  For reference,


@code : for code (mono-spaced font).  In Info format the block is enclosed in
single quotes.
@command : for UNIX commands, such as @command{ls}
@env  : for environment variables, such as @env{HOME}
@file : file names, such as @file{~/.hgrc}
@kbd  : keyboard input typed by user
@key  : a key, such as @key{RET} for Return
@option : for options, such as @option{-l}
@samp : catch-all for any text that should be set off from the surrounding
documentation, but is not one of the categories above.  The text will be
enclosed by single quotes in Info format.


The @qcode macro is one I designed because the single quotes around a piece of
text that is already quoted look horrible in Info format.


@code{"Text"} -> '"Text"' in Info
@qcode{"Text"} -> "Text" in Info


I also created the @tcode macro for code that ends with a transpose operator
(').


@code{y = x'} -> 'y = x''  in Info
@tcode{y = x'} -> y = x'   in Info


Perhaps we shouldn't bother to document "short e" form and just document
"shorte".  Both will be accepted by the format command, but the second form
doesn't have documentation problems.




    _______________________________________________________

Reply to this item at:

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

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




reply via email to

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