Fixes #901 : Added documentation for "step" in dti

[quantshah]

Fixes #901

[arokem]

Do you want to sort out those PEP8 issues, while we're here?

[arokem]

We might want to add a bit more explanation here (after the first sentence). Something like: "to increase speed of processing, tensor fitting is done simultaneously over many voxels. This parameter sets the number of voxels that will be fit at once in each iteration. Note that a larger number here should speed things up, but should also take up more memory, so keep an eye on your computers memory consumption as you increase this number.

Also, we should mention that this is an optional parameter, and that it has a default value (10,000).

We should also add all this to the documentation of the TensorModel object.

[quantshah]

Ok. I will add this and also update the documentaion for TensorModel object. For the pep8 issues, I can do it in this commit itself. But, if making a new branch just for pep8 isn't a big deal, I guess its better to create a seperate issue and fix pep8 there.

[quantshah]

Should the explanation come directly under the definition of step or I should include it under Notes. Also, the line - the increase in step value "should" speed things up but it should will also take up more memory - Is this correct? Regarding the memory

    """
            The chunk size as a number of voxels. Optional parameter with default value 10,000.

            In order to increase speed of processing, tensor fitting is done simultaneously
            over many voxels. The step parameter sets the number of voxels that will be fit at 
            once in each iteration. A larger step value should speed things up, but will 
            also take up more memory. It is advisable to keep an eye on memory consumption 
            as this value is increased.
    """

[quantshah]

@arokem Is this fine?

[arokem]

I was hoping to also document this at the level of the TensorModel object. Maybe in the __init__? It's specific to only some fitting methods (ols, wls), but these are rather important, and we want to give even the users who don't want to dig some information about this, I think.

[quantshah]

So all the functions here ?

[arokem]

Rather, somewhere here: https://github.com/nipy/dipy/blob/master/dipy/reconst/dti.py#L696

[quantshah]

Done 😄

[arokem]

Please change

iter_fit_tensor() => :func:iter_fit_tensor

Comment edited to deal with markdown vs. rst.

[arokem]

Cool. One more small change, so that this renders fine in sphinx (and add's a link in the html to the right function). Thanks for picking up those PEP8 bits as well!

[quantshah]

Done.

[arokem]

One more small thing - in the sphinx markup, the name of the function has
to be surrounded by backticks. See here:
http://stackoverflow.com/questions/21289806/link-to-class-method-in-python-docstring

On Sat, Mar 19, 2016 at 4:37 PM, Shahnawaz Ahmed notifications@github.com
wrote:

Done.

—
You are receiving this because you were mentioned.
Reply to this email directly or view it on GitHub
#972 (comment)

[quantshah]

Updated the backticks

[arokem]

This now looks fine to me. Anyone else want to give this a look?