Agrover112 / fliscopt

Algorithms for flight scheduling optimization.
https://pypi.org/project/fliscopt/
MIT License
39 stars 12 forks source link

fix:Add docstrings for each algorithm file. #41

Closed subhamgcon closed 2 years ago

subhamgcon commented 3 years ago

Fixing Issue #27 , Please check the added docstrings and if the format is correct, if wrong please help me to correct the mistakes because I am a complete beginner to Google Docstrings and even large Python Codebases. Thank you and have a great day!

Agrover112 commented 3 years ago

@subhamgcon Ahaha reviewing this is going to take a while 😅

subhamgcon commented 3 years ago

@Agrover112 Done.

Agrover112 commented 3 years ago

Hey @subhamgcon this is going to take a while to get merged since I will have to make many changes :( unless you want to help me out?

subhamgcon commented 3 years ago

@Agrover112 Yaaa sure Please tell me how can I help? :-)

Agrover112 commented 3 years ago

@subhamgcon So well, we have to write a docstring for the class . Just wait for some time . I will update the tasks here, we can work on together.

subhamgcon commented 3 years ago

@Agrover112 Okay!

Agrover112 commented 2 years ago

@subhamgcon I might need you to accept the Pull Request which updates docstring branch with master. After that I will accept the Pull Request. So pls do so asap!

Agrover112 commented 2 years ago

Hey @subhamgcon I raised a PR to the wrong branch I think. Can you update the docstring branch ?By pulling chages from Agrover112: master?

subhamgcon commented 2 years ago

@Agrover112 Can I do it tomorrow? I have a test so studying rn. Sorry

subhamgcon commented 2 years ago

Hey @Agrover112 Thank you for the guidance and doing the work alone. I was waiting for the mention I thought you are busy, still you did everything alone . Kudos!

Agrover112 commented 2 years ago

Hey @Agrover112 Thank you for the guidance and doing the work alone. I was waiting for the mention I thought you are busy, still you did everything alone . Kudos!

No problem dude, pls just make sure to view the changes I made to the docstring. The method you used was only for funcs as per Google Docstring Guide , I corrected it.

Cheers