bspwm
bspwm copied to clipboard
baskerville
Comments
Noticed there are no comments in any of the source files. I've been starting to read through the code to understand it all so I can contribute, and at some point would like to submit a pull request with some comments so other people looking to familiarize themselves with the codebase have a slightly easier time of it.
But before I started actually doing that work, I wanted to make sure there is no good reason for the lack of comments...
@rychipman Did you ever have time to work on this? I've been adding comments the past couple of days to my fork of this repo, mainly as a way to learn more about C programming. You can see my progress here: https://github.com/zjeffer/bspwm. I'm not sure everything is correct, though, but I'm slowly learning.
@baskerville A couple questions:
- Is this still something that is necessary?
- Is there anything I need to know about comment style before I continue with this? (e.g.: // vs /* */ for single line comments)
- Is there a maximum limit to the amount of comments I should add? I read about 'overcommenting' and I wonder if that could be a problem.
