Timeline for Is it ok to edit comments in code?
Current License: CC BY-SA 3.0
8 events
| when toggle format | what | by | license | comment | |
|---|---|---|---|---|---|
| Jul 31, 2013 at 20:40 | vote | accept | StephenTG | ||
| Jul 31, 2013 at 17:41 | comment | added | Aaron Bertrand Staff | @George however I disagree that a comment embedded in code is strictly code. Since if you remove it entirely, the code will still work. I don't see any harm in fixing spelling and grammar there, as long as there aren't any potential issues like the one djechlin pointed out (e.g. you should test that the code still compiles and runs as intended, and if it doesn't, maybe that is better criteria for leaving it alone). | |
| Jul 31, 2013 at 17:35 | comment | added | George Cummins | See the top two answers here. Their conclusions: "unless it's just a case of highlighting code as code, so that it displays nicely, you shouldn't change the code." and "Improving the grammar and spelling of the actual question is one thing, but changing code is a minefield." | |
| Jul 31, 2013 at 17:35 | answer | added | djechlin | timeline score: 8 | |
| Jul 31, 2013 at 17:25 | comment | added | StephenTG | @GeorgeCummins Out of curiosity, how would fixing spelling/grammar in a comment obscure the problem? | |
| Jul 31, 2013 at 17:23 | answer | added | Shog9Mod | timeline score: 12 | |
| Jul 31, 2013 at 17:19 | comment | added | George Cummins | There is a danger in editing code, including comments: You may accidentally obscure the problem. If you are just editing to satisfy an itch without adding real value to the question, my vote is that you leave it alone. | |
| Jul 31, 2013 at 17:17 | history | asked | StephenTG | CC BY-SA 3.0 |