[Top][All Lists]

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

[Octave-bug-tracker] [bug #54523] doc: link unmkpp with mkpp

From: Mike Miller
Subject: [Octave-bug-tracker] [bug #54523] doc: link unmkpp with mkpp
Date: Fri, 17 Aug 2018 14:41:30 -0400 (EDT)
User-agent: Mozilla/5.0 (X11; Linux x86_64; rv:61.0) Gecko/20100101 Firefox/61.0

Follow-up Comment #1, bug #54523 (project octave):

I have a few style suggestions for this change. The code example should be
written in Octave coding style (spaces around operators, after commas, after
function names). It should not be indented from the left, and you are missing
a @example block declaration. Something like this

## @example
## @group
## [x, p, n, k, d] = unmkpp (pp)
## pp2  = mkpp (x, p, d)
## fn = fieldnames (pp2);
## for i = 1:numel (fn)
##   assert (pp2.(fn{i}), pp.(fn{i}));
## endfor
## @end group
## @end example

>From a readability perspective, I think it would help if you explicitly said
in words what the 'assert' is attempting to prove. For someone unfamiliar with
these functions (like me), I don't think it's very clear that your example is
trying to show "here is how the deconstructed piecewise polynomial structure
can be constructed back again into an equivalent structure". Maybe even
writing some text and eliminating the distraction of the for loop would be

The commit message should include both a summary line, with (bug #54523)
appended, and a details line with something like

* unmkpp.m: Add example to doc string showing relationship with mkpp.


Reply to this item at:


  Message sent via Savannah

reply via email to

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