devolearn: add links to documentation in comments

[Mayukhdeb]

Someone has to add link(s) to the documentation within the function comments.

It is fine to add only one link to only one function to make a PR. We do not require for you to add all the links for all the functions.

Please see the example below:

I'll be referring to line 58 in the lineage_population_model.py

The snippet there currently looks like this:

    def predict(self, image_path):

        """
        input{
            image path <str>
        }
        output{
            dictionary containing the cell population values <dict>
        }

But we want somehting like:

    def predict(self, image_path):

        """
        reference{
            https://github.com/DevoLearn/devolearn#predicting-populations-of-cells-within-the-c-elegans-embryo
        } 
        input{
            image path <str>
        }
        output{
            dictionary containing the cell population values <dict>
        }

[rudrajit1729]

@Mayukhdeb I can work on this. Please assign this to me. Thanks

[Mayukhdeb]

Thank you for your interest Rudrajit, we're loooking forward to your pull request :)

[rudrajit1729]

Do you need the same reference (https://github.com/DevoLearn/devolearn) across your codes. Please clear this @Mayukhdeb

[Mayukhdeb]

No, but you're almost right here:

We want you to add links to the respective documentation headings in the README.md file for the functions. Not just the link to the repository

The link that we'd want for the example shown above is:

https://github.com/DevoLearn/devolearn#predicting-populations-of-cells-within-the-c-elegans-embryo

And not:

https://github.com/DevoLearn/devolearn

Notice the #readme-heading in the end of the link.

[rudrajit1729]

ok got it. thanks

[rudrajit1729]

Done and submitted for review #19 Please review and merge if it satisfies the problem statement.

[rudrajit1729]

@Mayukhdeb