Add docstrings for each algorithm file.

Agrover112 / fliscopt

Algorithms for flight scheduling optimization.

https://pypi.org/project/fliscopt/

MIT License

39 stars 12 forks source link

Add docstrings for each algorithm file. #27

Closed Agrover112 closed 2 years ago

Agrover112 commented 3 years ago

There are few files which contain implementation of the algorithms: [sa,ga,hc,chaining,rs].py you need to write the docstring for the classes present in each file using Google Docstring Convention. Refer: algorithms.py on how to write docstrings for functions and similarily refer THIS and THIS link for on getting started on how to write docstrings for the classes. PS : Google Style Guide

[ ] chaining.py
[ ] ga.py
[ ] rs.py
[ ] sa.py
[ ] hc.py

subhamgcon commented 3 years ago

Hey @Agrover112 Can I work on this?

Agrover112 commented 3 years ago

Ok @subhamgcon let me assign you.

subhamgcon commented 3 years ago

Ok @subhamgcon let me assign you.

Okay.

Agrover112 commented 3 years ago

Are you working on it @subhamgcon

subhamgcon commented 3 years ago

Are you working on it @subhamgcon

Actually I wasn't because I thought you will assign it to me then I can work on it. Now I am working on it.

Agrover112 commented 3 years ago

my bad I forgot @subhamgcon