search

cmougan / WRI_WellBeing_Data_Layer

MIT License
6 stars 4 forks source link

[DOC] : Add documentation to the dssg directory README on the organization of code. #10

Open sunayana opened 3 years ago

cmougan commented 3 years ago

With this you mean describe in a paragraph all the sections?

rohaan2614 commented 3 years ago

Hey @sunayana , I see this is self-assigned but can I help with this? (I don't fully understand the issue description though, a little clarification will help :) )

sunayana commented 3 years ago

Hi @rohaan2614 thanks, that would be great, if you could do that, I would have done it next week otherwise. It is more about creating a documentation for the code, something along the lines https://developer.lsst.io/python/numpydoc.html And then compile it to markdown files or rst files. This would mean to go through the code in the dssg/dataio folder mainly and add comments, something along these lines 

"""Sum numbers in an array.

Parameters
----------
values : iterable
   Python iterable whose values are summed.

Returns
-------
sum : `float`
   Sum of ``values``.
"""

I would look into it Monday or Tuesday next week otherwise.

rohaan2614 commented 3 years ago

I will add some on Sunday. You can review them on Monday or whenever you have time.

Just to confirm, this is the directory of those codes, right?

sunayana commented 3 years ago

I will add some on Sunday. You can review them on Monday or whenever you have time.

Just to confirm, this is the directory of those codes, right?

Yes that is the directory. Thanks!