bugGNU Octave - Bugs: bug #66015, Document ERROR_ID in docstring for...

 
 

bug #66015: Document ERROR_ID in docstring for error() function

Submitter:  Rik <rik5>
Submitted:  Wed 24 Jul 2024 12:16:33 AM UTC
   
 
Category:  Documentation Severity:  3 - Normal
Priority:  5 - Normal Item Group:  Documentation
Status:  Ready For Test Assigned to:  None
Originator Name:  Open/Closed:  * Open
Release:  * 9.2.0 Operating System:  * Any
Fixed Release:  None Planned Release:  9.3.0 (current stable)
* Mandatory Fields

Add a New Comment Rich Markup
   

Fri 06 Sep 2024 01:48:14 PM UTC, comment #2: 

Thanks for the patch.

I added an additional sentence to be more explicit about the requirements for an error id and pushed it to the stable branch:
https://hg.savannah.gnu.org/hgweb/octave/rev/710a50bab50f

Marking as ready for test.

Markus Mützel <mmuetzel>
Group administrator
Thu 29 Aug 2024 08:23:49 PM UTC, comment #1: 

How about the attached changeset?

(file #56396)

Pantxo Diribarne <pantxo>
Group Member
Wed 24 Jul 2024 12:16:33 AM UTC, original submission:  

I noticed today that the docstring for error() has a calling form


-- error (ID, TEMPLATE, ...)


but it is never actually documented what ID should be.

Rik <rik5>
Group administrator

 

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

Attach Files:
   
   
Comment:
   

Attached Files
file #56396:  bug66015.patch added by pantxo (1KiB - text/x-patch)

 

Depends on the following items: None found

Items that depend on this one: None found

 

Carbon-Copy List
  • -email is unavailable- added by mmuetzel (Posted a comment)
  • -email is unavailable- added by pantxo (Updated the item)
  • -email is unavailable- added by rik5 (Submitted the item)
  •  

    There are 0 votes so far. Votes easily highlight which items people would like to see resolved in priority, independently of the priority of the item set by tracker managers.

    Only group members can vote.

     

    Follow 4 latest changes.

    Date Changed by Updated Field Previous Value => Replaced by
    2024-09-06 mmuetzel Planned ReleaseNone 9.3.0 (current stable)
    2024-09-06 mmuetzel StatusPatch Submitted Ready For Test
    2024-08-29 pantxo Attached File- Added bug66015.patch, #56396
        StatusConfirmed Patch Submitted

    Back to the top

    Powered by Savane 3.13-461b.
    Corresponding source code