bugGNU Octave - Bugs: bug #36524, Upgrade defun macro to accept...


bug #36524: Upgrade defun macro to accept non-double-quoted string for DOCSTRING

Submitted by:  Rik <rik5>
Submitted on:  Tue 22 May 2012 04:12:32 PM UTC  
Category: Configuration and Build SystemSeverity: 2 - Minor
Priority: 5 - NormalItem Group: Incorrect Documentation
Status: FixedAssigned to: None
Originator Name: Open/Closed: Closed
Release: devOperating System: Any

Add a New Comment (Rich MarkupRich Markup):

You are not logged in

Please log in, so followups can be emailed to you.


Fri 01 Jul 2016 02:19:56 AM UTC, comment #4:

It's been a week or so, everything seems to still be working, closing as fixed.

Mike Miller <mtmiller>
Project Administrator
Wed 22 Jun 2016 06:50:58 PM UTC, comment #3:

Can this issue about docstrings be closed now?

Rik <rik5>
Project Administrator
Tue 21 Jun 2016 08:33:16 PM UTC, comment #2:

I committed a changeset for this because I think it's worth doing to make editing docstrings easier, but it's big and disruptive. Many patches may fail if they touch docstrings.


John W. Eaton <jwe>
Project Administrator
Sun 01 May 2016 10:31:52 AM UTC, comment #1:

Another reason to do this would be to allow conditional text within the docstring, based on which HAVE_... macros are defined.
Treating the docstring as a C string would allow

but since these are parsed by sed instead being treated as C strings, this introduces a spurious pair of double quotes.

The patch for bug #45654 would benefit from that, since functionality depends on HAVE_SETPGID. Things such as graphics_toolkit may also benefit from being able to provide installation-specific help.

One solution may be to use sed to extract a short section of C/cpp code containing a printf to generate the .df file, though that may be rather slow.

Severity: Wishlist -> Minor

Lachlan Andrew <lachlan>
Project Member
Tue 22 May 2012 04:12:32 PM UTC, original submission:

From an e-mail exchange with JWE there was a proposal to expand the current DEFUN macro to accept a simple string for the DOCSTRING portion of the macro. This would make entering and editing of the documentation easier as we could drop the excessive backslashing that is currently required.

Rik <rik5>
Project Administrator


(Note: upload size limit is set to 16384 kB, after insertion of the required escape characters.)

Attach File(s):

No files currently attached


Depends on the following items: None found

Items that depend on this one: None found


Carbon-Copy List
  • -unavailable- added by mtmiller (Posted a comment)
  • -unavailable- added by jwe (Posted a comment)
  • -unavailable- added by lachlan (Posted a comment)
  • -unavailable- added by rik5 (Submitted the item)

    Do you think this task is very important?
    If so, you can click here to add your encouragement to it.
    This task has 0 encouragements so far.

    Only project members can vote.


    Please enter the title of George Orwell's famous dystopian book (it's a date):



    Follow 6 latest changes.

    Date Changed By Updated Field Previous Value => Replaced By
    Fri 01 Jul 2016 02:19:56 AM UTCmtmillerStatusReady For Test=>Fixed
    Wed 22 Jun 2016 06:50:58 PM UTCrik5StatusNone=>Ready For Test
    Wed 22 Jun 2016 09:46:17 AM UTClachlanDependenciesRemoved dependancy from bugs #45654=>-
    Sun 01 May 2016 10:31:52 AM UTClachlanSeverity1 - Wish=>2 - Minor
    Sat 30 Apr 2016 09:52:45 AM UTClachlanDependencies-=>bugs #45654 is dependent

    Back to the top

    Powered by Savane 3.1-cleanup