Hacker News Reader

Or no comment at all. This code is as self-documenting as you can get.

"# check if frame is None" is indeed a good example of comments you should not write. It's weird that someone has the skill to create what seems such a complete lib and yet produces what most would qualify as a beginner structure.

If the project holds up, it's definitely a teaching moment for me.

I noticed reading some of the comments here that they don't get into what a "good" comment is. Many critiques on HN will try to identify best practices, but with comments, and writing generally, it's more a skill you have to learn.

The weirdness you mention can be explained, I think, by the fact that the project has a single contributor.[1]

A person learns which patterns work or not when patterns clearly work or fail. Since bad comments are something that affects maintenance without breaking the code, it wouldn't be surprising if the internals are solid while the code is less maintainable.

And I predict that if it takes off, you'd see other contributors pushing back against the extraneous comments, and Abhishek's style in commenting evolve.

[1]: https://github.com/abhiTronix/vidgear/graphs/contributors

Reply on news.ycombinator.com