Add a section about string quoting to CONTRIBUTING #2322
Conversation
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
CONTRIBUTING.md
Outdated
| In above example, 'key' is an identifier, usually using characters from `[a-z0-9_]` set. | ||
| But the printed string is translatable (English phrase). | ||
|
|
||
|
|
Check warning
Code scanning / Markdownlint (reported by Codacy)
Expected: 1; Actual: 2 Warning
| @@ -56,6 +56,50 @@ | |||
|
|
|||
| `gettext` and `gettext-noop` have been built-in the Picard code as `_` and `N_` respectively to provide support for internationalization/localization. You can use them without imports across all of Picard code. Make sure to mark all displayable strings for translation using `_` or `N_` as applicable. You can read more about python-gettext [here](https://docs.python.org/2/library/gettext.html). | |||
|
|
|||
| ### Strings quoting: single or double quotes? | |||
|
|
|||
| As a general guideline, we tend to use double quotes for translatable strings and/or English phrases; or anything that may contain one or more single quotes. | |||
Check warning
Code scanning / Markdownlint (reported by Codacy)
Expected: 80; Actual: 157 Warning
| ### Strings quoting: single or double quotes? | ||
|
|
||
| As a general guideline, we tend to use double quotes for translatable strings and/or English phrases; or anything that may contain one or more single quotes. | ||
| We use single quotes for identifiers and keys (those are unlikely to contain a single quote; and usually no special character or space). |
Check warning
Code scanning / Markdownlint (reported by Codacy)
Expected: 80; Actual: 136 Warning
|
|
||
| ``` | ||
|
|
||
| In above example, 'key' is an identifier, usually using characters from `[a-z0-9_]` set. |
Check warning
Code scanning / Markdownlint (reported by Codacy)
Expected: 80; Actual: 88 Warning
| print(d['small']) | ||
| ``` | ||
|
|
||
| In above example, `l1` contains identifiers (keys of dict `d`) while others are English words/phrases. |
Check warning
Code scanning / Markdownlint (reported by Codacy)
Expected: 80; Actual: 102 Warning
Summary
Problem
Solution
Action