search

sockheadrps / PyProfileDataGen

This generates some data visualizations about a github users python projects and appends them to the profile via a work flow
GNU General Public License v3.0
3 stars 2 forks source link

2 add docstrings, comments, type hints #8

Closed CracktheDom closed 1 month ago

CracktheDom commented 1 month ago

Addresses issues #2; Add docstrings, comments & type hints to various Python files to increase readability.

sockheadrps commented 1 month ago

Hey I just noticed this PR, thanks for showing interest in the project! Ill get around to reviewing this either later tonight or tomorrow. For the most part what Ive seen looks like a good direction to move in, and I'll probably end up merging these changes.

sockheadrps commented 1 month ago

Actually, looking into this further, I dont see much added value here. There's a lot of pointless changes to comments, and this was clearly AI generated. I dont mind people contributing to the repo, but it needs to reflect thoughtful consideration. Some of the typing changes were useful but being so mixed into the changes to documentation made it really difficult to parse. I would consider merging it under a separate PR, but to be completely honest I dont think its a good use of my time to review a PR when it required just a small fraction of time to generate it in the first place.

CracktheDom commented 4 weeks ago

I disagree with your assessment pertaining to the value of adding documentation. Code is written by humans, FOR humans and improving readability so other humans can more easily peruse code does add value. I have found using LLM's to address repetitive tasks like writing documentation to be a value-adding, time-saving task.