[Top][All Lists]

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

[Octave-bug-tracker] [bug #52774] help for continuation marker has stran

From: Dan Sebald
Subject: [Octave-bug-tracker] [bug #52774] help for continuation marker has strange extraneous statement
Date: Tue, 2 Jan 2018 05:32:58 -0500 (EST)
User-agent: Mozilla/5.0 (X11; Ubuntu; Linux x86_64; rv:55.0) Gecko/20100101 Firefox/55.0

Follow-up Comment #2, bug #52774 (project octave):

Ah, OK:

octave:14> x = "Continuing ...
warning: '...' continuations in double-quoted character strings are obsolete
and will not be allowed in a future version of Octave; please use '\' instead
> here"
x = Continuing here

Thanks.  I suppose it is worthwhile adding a short note to the "help \" for
this, i.e., "Also continuation marker in double-quote strings".  However,
there's an ongoing discussion of potential new double-quote string
feature/behavior, so it might be wise to hold off adding such a thing because
in not too long of time such a statement might just be cruft that I and other
forget about.

On the other hand, I think it is alright to simply put a reference in the
manual so that the Operator Index has an extra page number associated with \
continuation marker.  In fact, all I needed to do was change @cindex to
@opindex.  And if the \ continuation marker is deprecated, the index reference
will go away when removing the associated paragraph from the manual.

I'm attaching a changeset that cleans up several items in the octave.pdf
manual.  I made liberal use of the Texinfo command @sortas to move all the
messy symbol entries at the start of Concept Index to other places that would
be logical starts for a reader, e.g., both .octaverc and ~/.octaverc now go
under "octaverc" but have the same appearance so it is clear what they refer
to.  I also added a copy more page numbers to those entries directing to the
command-line switches that disable loading them at startup.

All of the command-line options -W, --eval, etc. have been moved to "options,
Octave command".  They look nice there and have context rather than loosely
sitting at the start of the Concept Index.  The -W and --eval index entries
were missing.  There was an extraneous -? entry for an apparently deprecated
equivalent to --help and -h that I removed.

The source of those three strange functions at the start of Function Index was
a broken @deftypefnx format in xticks.m and xticklabels.m that was missing the
{} for cases where the function doesn't return an output.  I also fixed the
other similar script files, but they aren't input to the user manual...maybe
they are used for generating the online-help though.

With that, it looks pretty nice.  I wonder about the graphics properties
entries that are automatically generated.  There is a big list of them, and it
actually isn't too difficult to look through the way they are.  But because of
they are organized by "figure", "image", etc. the property groups are strewn
through the Concept Index.  We could consider organizing all of those
properties into their own index.  Or maybe put them all under "properties"
using @sortas creatively inside genpropdoc.m.

(file #42787)

Additional Item Attachment:

File name: octave-manual_texinfo_cleanup-djs2018jan01.patch Size:19 KB


Reply to this item at:


  Message sent via/by Savannah

reply via email to

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