[Octave-patch-tracker] [patch #9691] Modular Inverse Matrices using the Gauss-Jacques Method

[Juan Pablo Carbajal]

Follow-up Comment #1, patch #9691 (project octave):

Hi,

Thanks this looks interesting.
However the code needs quite some formal work.

Among the most important it needs documentation (i.e. help for users ot learn
how to use the function). This is the text you get when you run, for example
`help sqp`. You can start looking inside that function (find it using `which
sqp`) and write a docstring. If you do that, others will take over and improve
it.

Another helpful thing would be to have a couple of demos. for example a simple
problem that can be verified with pencil and paper; and another fancy one.
This, again, helps the user understand how to use your function and for what
it can be useful.

Finally, you could add some tests, so when changes start being applied to your
function we are sure we are not destroying functionality or adding new bugs.

Read all about these stuff in the manual:
https://octave.org/doc/interpreter/Test-and-Demo-Functions.html#Test-and-Demo-Functions
https://octave.org/doc/v4.0.0/Documentation-Tips.html



    _______________________________________________________

Reply to this item at:

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

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