|
Size: 981
Comment:
|
Size: 1798
Comment: Style guide for status and error messages
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 1: | Line 1: |
| ## page was renamed from Basic Coding Style | |
| Line 6: | Line 7: |
| * don't name functions with CamelCase * don't name functions with lots_of_under_bars |
* don't name functions or classes with Uppercase, !CamelCase or lots_of_under_bars |
| Line 9: | Line 9: |
| * don't name your classes in Uppercase | |
| Line 12: | Line 11: |
| * don't use a class to encompass something that's not conceptually an object * don't use sorted(), rstrip(), or various other post-Py2.3 goodies * don't put OS-specific hacks outside of util.py and friends. |
* don't use a class unless it makes your code smaller and easier to read * don't use Unicode strings unless you ''really'' grok Mercurial's charset philosophy * don't put OS-specific hacks outside of util.py and friends * don't use Python features from 2.5 or later (so no conditional expressions, unified try/except/finally) |
| Line 28: | Line 28: |
== Status and Error Messages == Short messages should look like this: {{{ adding foo.txt }}} Note the following: * it start with a ''lower-case'' word. * it has no trailing full-stop (`.`). Some existing strings don't follow this style and are kept like that for backwards compatibility reasons. But please write all new strings in this style. The above message should look like this in your code: {{{ ui.status(_('adding %s\n') % filename) }}} Please note: * The `_` function is used to mark the string as translatable. Import it from the `i18n` module. * The string interpolation is done ''after'' the call to the `_` function. ---- CategoryContributing |
Don'ts:
- don't use tabs
- don't use lines longer than 80 characters
- don't leave trailing whitespace
don't name functions or classes with Uppercase, CamelCase or lots_of_under_bars
- don't make helper functions prefixed with do_
- in general, don't make ["mpm"] use his shift key any more than he has to
- don't use default arguments without a good reason
- don't use a class unless it makes your code smaller and easier to read
don't use Unicode strings unless you really grok Mercurial's charset philosophy
- don't put OS-specific hacks outside of util.py and friends
- don't use Python features from 2.5 or later (so no conditional expressions, unified try/except/finally)
Do:
- use single quotes rather than double quotes
- use a single underscore prefix for private methods and functions
- use a single underscore prefix for a helper function
- add a linebreak after a colon
- add docstrings
- use _() to mark things for i18n
- add testcases to the test suite
- run the test suite
-- ["mpm"]
Status and Error Messages
Short messages should look like this:
adding foo.txt
Note the following:
it start with a lower-case word.
it has no trailing full-stop (.).
Some existing strings don't follow this style and are kept like that for backwards compatibility reasons. But please write all new strings in this style.
The above message should look like this in your code:
ui.status(_('adding %s\n') % filename)Please note:
The _ function is used to mark the string as translatable. Import it from the i18n module.
The string interpolation is done after the call to the _ function.