search

AlphonsG / Rainbow-Optical-Flow-For-ALI

Automated air liquid interface cell culture analysis using deep optical flow.
MIT License
4 stars 0 forks source link

Review points #24

Closed Assistedevolution closed 2 years ago

Assistedevolution commented 2 years ago

Do you have links to the underlying documentation for the Code?

AlphonsG commented 2 years ago

The code for rainbow has been documented using API method/function documentation in Google Python Style. For example:

https://github.com/AlphonsG/Rainbow-Optical-Flow-For-ALI/blob/9af871407bb3fd6b0bf3f1f4f77cb348de509487/rainbow/file_processing.py#L93-L107

Assistedevolution commented 2 years ago

This is probably ok, so go ahead and close.

On the next project you might find using something like NBDev which will help you document everything as you work. This will make it easier for folk to expand upon/reuse the work you have done

AlphonsG commented 2 years ago

Alright thanks.