octave-patch-tracker
[Top][All Lists]
Advanced

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

[Octave-patch-tracker] [patch #10008] [octave forge] (statistics) Add fu


From: Philip Nienhuis
Subject: [Octave-patch-tracker] [patch #10008] [octave forge] (statistics) Add function inconsistent
Date: Sun, 3 Jan 2021 15:13:23 -0500 (EST)
User-agent: Mozilla/5.0 (Windows NT 6.1; rv:52.0) Gecko/20100101 Firefox/52.0

Follow-up Comment #2, patch #10008 (project octave):

Thanks for this contribution.

Remarks after a brief look (just coding style etc, not inner working of the
function):
* The first line after the function call definitions (@deftypefn) should end
with a period. The functions we use to extract the texinfo for docs and the
function listing on the octave-forge site etc. rely on it (although they
aren't _that_ fragile).
* Having a nested function somewhere seemingly at random in the middle of the
function code can be hard to follow. However, AFAIK we have no coding standard
for that yet. Could you make it a subfunction outside the main function body
(I guess you'd have to add 'Z' as input arg), or otherwise put it at the end
or start of the main function body?
* All comment lines should start with double hashes ('##').
* Consistently use one space between function name and opening parenthesis and
after a comma separating arguments or values. (Except when concatenating
between square brackets).
* I'm a bit wary of copying data the competition also uses (although they seem
to originate from a public site - have you checked the licensing conditions
there?), especially when using it in a BIST literally.
* You can already add 'cluster' in the seealso macro.


    _______________________________________________________

Reply to this item at:

  <https://savannah.gnu.org/patch/?10008>

_______________________________________________
  Message sent via Savannah
  https://savannah.gnu.org/




reply via email to

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