Closed kn-neelalohitha closed 4 years ago
Docstrings are added in
__init__
andmake_xl_name
Either drop the docstrings from both of them or add docstrings toStudentsList
,make_pkl_file
,load_pkl_file
andmake_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.
Thanks for the PR @kn-neelalohitha 🎉
It's a pleasure contributing to this project!
What is this PR/ Why this PR?
This PR refactors
StudentsList
class in the student_list.py byModifications:
class_name
from the methodsmake_xl_name()
andmake_pkl_name()
.Reason: The methods
make_xl_name()
andmake_pkl_name()
earlier consumedclass_name
to output the complete file path. However, this is not required as theclass_name
being an attribute ofStudentsList
class in the student_list.py can be accessed directly without explicit passing.Signed-off-by: knn kn.neelalohitha@gmail.com