added comments to beautify.py

TechWiz-3 / who-unfollowed-me

😡 Python CLI tool that shows you who has unfollowed you on GitHub. PRs welcome!

GNU General Public License v3.0

11 stars 24 forks source link

added comments to beautify.py #61

Closed advik-student-dev closed 1 year ago

advik-student-dev commented 1 year ago

Type of change

added comments too beautify.py - breaking code into sections

TechWiz-3 commented 1 year ago

I don't feel those comments are useful. Don't get me wrong but nobody needs a comment saying # imports when the next 4 lines are imports. Same goes for the other comments.

You could for example, make a docstring for the get_inverse and beautiful_unfollows functions.

Thank you, you perfectly articulated my issue with this PR.

Please take note @advik-student-dev