bugGNU Octave - Bugs: bug #61156, dsearchn: docstring doesn't...

 
 

bug #61156: dsearchn: docstring doesn't explain output variable 'd'

Submitted by:  Nicholas Jankowski <nrjank>
Submitted on:  Tue 14 Sep 2021 05:27:11 PM UTC  
 
Category:  Documentation Severity:  2 - Minor
Priority:  5 - Normal Item Group:  Documentation
Status:  Fixed Assigned to:  Nicholas Jankowski <nrjank>
Originator Name:  Nicholas Jankowski Open/Closed:  Closed
Release:  dev Operating System:  Any

Add a New Comment (Rich Markup)
   

You are not logged in

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

 

Fri 17 Sep 2021 09:11:21 PM UTC, comment #2: 

Good catch. I thought this was simple-enough to use the one line commit style. (https://wiki.octave.org/Commit_message_guidelines#One_line_examples).  Thanks for the help.

Nicholas Jankowski <nrjank>
Project MemberIn charge of this item.
Fri 17 Sep 2021 07:57:20 PM UTC, comment #1: 

I checked in your change on stable and then merged to the default branch.  See http://hg.savannah.gnu.org/hgweb/octave/rev/6cc5315cdf2f.

I made small changes to the wording to correspond to the guidelines for help text (https://wiki.octave.org/Help_text_style_guide).  In this instance, it was changing the future tense to the present tense.

I also changed the commit message to have a summary line and then a per-file change line.  Octave has guidelines for commit messages too!  See https://wiki.octave.org/Commit_message_guidelines.

It's a steep learning curve, but then becomes pretty natural.  Thanks for the changeset.

Marking as fixed and closing report.

Rik <rik5>
Project Administrator
Tue 14 Sep 2021 05:27:11 PM UTC, original submission:  

noticed that the dsearchn function includes an optional output 'd' to return the distance to the nearest triangulation point , but it is not described at all in the docstring.  Added that description in the patch I'll attach once I get a bug #.

Nicholas Jankowski <nrjank>
Project MemberIn charge of this item.

 

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

Attach Files:
   
   
Comment:
   

Attached Files
file #51910:  bug61156_delaunayn_docstring.diff added by nrjank (982B - application/octet-stream)

 

Depends on the following items: None found

Items that depend on this one: None found

 

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

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

    Only project members can vote.

     

     

     

    Follow 4 latest changes.

    Date Changed by Updated Field Previous Value => Replaced by
    2021-09-17 rik5 StatusPatch Submitted => Fixed
        Open/ClosedOpen => Closed
    2021-09-14 nrjank Summarydsearchn: docstring doesn't explain all output variables => dsearchn: docstring doesn't explain output variable 'd'
    2021-09-14 nrjank Attached File- => Added bug61156_delaunayn_docstring.diff, #51910

    Back to the top


    Powered by Savane 3.6