c2c-oerpscenario team mailing list archive
-
c2c-oerpscenario team
-
Mailing list archive
-
Message #03968
[Bug 673087] Re: Spelling errors in the code
Lionel, I think the arguments you used in the description are wrong to
qualify this operation as not risky, because none of them are foolproof:
- "renaming variables and functions is easily and quickly done (ecplise even has a wizard for it)"
-> this is very error-prone with a dynamic language like Python. PyDev's wizard in Eclipse often leads to issues, being either too eager or too lazy
- "bzr lets you review what you merge"
-> yes, quite risky indeed, humans make errors all the time, so we should refrain from adding more opportunities for errors when we are looking for low-risk!
- "yml tests will catch the problems"
-> YAML tests don't have 100% coverage of the code, and even when they will, they will never be able to catch 100% of error/regressions. They are a tool to help developers, not an excuse to be overconfident, negligent or careless!
Just my 2 cents ;-)
--
Spelling errors in the code
https://bugs.launchpad.net/bugs/673087
You received this bug notification because you are a member of C2C
OERPScenario, which is subscribed to the OpenERP Project Group.
Status in OpenObject Addons Modules: Opinion
Bug description:
There are lots of small spelling mistakes throughout the code : datas=data, childs=children, logistic=logistics etc.
I think these deserve to be fixed one day.
The point of correct English in the code is:
- well-written code is a documentation in itself
- you can't search for misspelled words in IDEs
- bad English is a clue to find code that was never reviewed nor refactored
- respect for your fellow developers worldwide
It's not risky because:
- renaming variables and functions is easily and quickly done (ecplise even has a wizard for it)
- bzr lets you review what you merge
- yml tests will catch the problems
Lionel
Related bugs : Bug #326160, Bug #327259
References