Marauders-9998 / Attendance-Management-using-Face-Recognition

A Desktop App made in Python to handle tasks related to Attendance Management of an Institute
GNU General Public License v3.0
31 stars 29 forks source link

Refactor student_list.py #24

Closed kn-neelalohitha closed 4 years ago

kn-neelalohitha commented 4 years ago

What is this PR/ Why this PR?

This PR refactors StudentsList class in the student_list.py by

Modifications:

Reason: The methods make_xl_name() and make_pkl_name() earlier consumed class_name to output the complete file path. However, this is not required as the class_name being an attribute of StudentsList class in the student_list.py can be accessed directly without explicit passing.

Signed-off-by: knn kn.neelalohitha@gmail.com

kn-neelalohitha commented 4 years ago

Docstrings are added in __init__ and make_xl_name Either drop the docstrings from both of them or add docstrings to StudentsList, make_pkl_file, load_pkl_file and make_pkl_name as well.

Docstring is added to all of them. For StudentsList class I have summarised what it does and briefly explained about class variables names and rolls. I skipped writing docstrings for the public class methods as it would be an unwanted repetition.

Vibhu-Agarwal commented 4 years ago

Thanks for the PR @kn-neelalohitha 🎉

kn-neelalohitha commented 4 years ago

It's a pleasure contributing to this project!