Skip to content

Add documentation #2

Open
Open
@akshitadixit

Description

@akshitadixit

The current code contains minimalistic documentation that too at only some places. Objective of this issue will be:

  • Improve readme instructions
  • Add comments in code
  • Add docstrings for functions that might need elaborate commenting

You are free to pick up any or all of the above 3 sub-tasks.
For any assistance, feel free to reply to this.

Metadata

Metadata

Labels

LGMSOC21This issue will be considered for LGM-SOC 21good first issueThis issue is good for first timers🟩 Level1This issue will be considered as level 1 issue for LGM-SOC 21.Points will be 5

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions