Improve descriptions of variables in docstring

quinngroup / dr1dl-pyspark

Dictionary Learning in PySpark

Apache License 2.0

1 stars 1 forks source link

Improve descriptions of variables in docstring #34

Closed magsol closed 8 years ago

magsol commented 8 years ago

The descriptions of the parameters to op_selectTopR and op_getResidual are not very descriptive, e.g. vct_input: indicating input vector. Please improve these descriptions to provide a new user with intuition for exactly what the parameter is, how it is used, and what its larger role is in the overall program.

MOJTABAFA commented 8 years ago

it's done! but I hope no more space problem again created by this commit :)