Issues with more description, :)
Closed this issue · 2 comments
Hey Valerie. I have noticed your contribution to the room demo and it's quite impressive.
As I am sorta now not much to do with Visualizer, started poking here and there adding a bit of touch.
However I have observed your tendency to commit first with little explanation.
I am new to python and scripted language at all. I really need you to help me out here; can you comment on "why" on "what" you did?
For your recent issue, first time I saw it, I thought you were trying to "style" it. Then I realized oh maybe what she meant is that Python3 needs parenthese.
And also how are you even running this thing with python 3? Visualizer code I had was not compatible with python 3 so I had to use 2.7 instead.
It's a bit late to respond to this, but I'll put notes here anyway. When I write code, I won't explain why in the commit because that makes the code hard to read. Comments are for how, not why, and any why explanation needs to go in the relevant section of the issue tracker. Having conversations in code comments is not good practice. I'll be removing cluttered explanations from code that I work on because it makes it harder to use, so please put them in the tracker. However, if you do need more 'how', I do often forget to comment thoroughly enough, so just make an issue about the section you think needs more comments.
My commit comment will explain the purpose of changes, for example, that commit where I added the parentheses (which at this point would be almost purely style) was labeled 'made python3 compatible' which would mean that yes, I did put the parentheses there for that purpose.
I think with the new visualizer issues, you will be working on that for a while now though, so this sort of thing probably won't be an issue. When you would like to work on the demo again, you might want to ask Joe or I what the current state is.
yeah, I think about it now. commenting within the code as method of communication doesn't sound good. Ty for the reply.