Documenting Source Code

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

Documenting Source Code #17

Open Vibhu-Agarwal opened 4 years ago

Vibhu-Agarwal commented 4 years ago

The source currently lacks comments to describe what's going on at various sections. Comments can be added to help ease the understanding of code-base.

Please refer to PEP 8 Guidelines while documenting.

kn-neelalohitha commented 4 years ago

I would like to work on this. Currently, I am working on #23, but, I feel I need to understand the project(codebase) even more. Previously, I have written the comments for students_list.py (Ref. #24). Please assign me this issue as well.

Vibhu-Agarwal commented 4 years ago

@kn-neelalohitha Generally, we don't recommend working on multiple issues at one time. Understandably, you require time to understand the codebase. Take your time 👍 I won't be assigning you to this issue because it's quite general and would require consistent work. But that won't stop you from documenting the source code. PRs are most welcome.