octave-maintainers
[Top][All Lists]
Advanced

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

Re: odepkg: odeset profile tests


From: Carlo De Falco
Subject: Re: odepkg: odeset profile tests
Date: Fri, 5 Dec 2014 05:49:00 +0000

On 4 Dec 2014, at 11:55, Carlo De Falco <address@hidden> wrote:

> On 4 Dec 2014, at 10:07, Jacopo Corno <address@hidden> wrote:
>>> 
>>> 
>>> Furthermore, it seems fuzzy_compare would need to go into Octave core as 
>>> well, but as it is now
>>> it is absolutely not acceptable, formatting, documentation and comments
>>> (too many useless and annoyingly verbose comments don't make the code more 
>>> readable)
>>> all need a lot of improvement.
>> 
>> I will take care of that.
>>> 
>>> c.
>>> 
>> Jacopo
> 
> Hi,
> 
> I had a look at your changes to fuzzy_compare, it is getting better
> but still not there.
> 
> I made changes in a clone of your repo but creating a pull request
> does not seem to work. I contacted bitbucket support about it.
> In the meantime, I attach the changesets below.
> 
> Main changes:
> 
> - The copyright notice must be changed if you want this to go 
>   into core.
> 
> - Long lines should be truncate in comments as well.
> 
> - Comments should be written in imperative mood:
> 
>  - ## initializing the vector that will contain the distances
>  - values = inf .* ones (fields_nb, 1);
>  + ## initialize the vector that will contain the distances
>  + values = inf .* ones (fields_nb, 1);
> 
> I did not remove comments, but I still think that some of them like 
> the one above are absolutely useless and redundant.
> 
> you can apply this changes to your repo with the command
> 
> hg import <filename>
> 
> c.


Hi,

Looking at your latest commits, there is one more thing to take care of.

You should not reference "odepkg" in the "seealso" part of the docstring
of a function that goes into core Octave because some users may not have the
odepkg package installed, so for them "help odepkg" will not work.

c.





reply via email to

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