Friday, September 18, 2026
1 change · master
New functionality added to Odoo
This update adds guidance for Odoo skill documentation to use simple ASCII punctuation in comments, messages, and related prose. It also cleans up existing guideline text so translators and reviewers see fewer near-duplicate strings caused only by special punctuation.
Original PR description
**Description of the issue/feature this PR addresses:** The skill library has no guideline about the prose written alongside the code: comments, docstrings, user-facing strings and commit messages.…
**Description of the issue/feature this PR addresses:** The skill library has no guideline about the prose written alongside the code: comments, docstrings, user-facing strings and commit messages. Em dashes keep appearing there. They are absent from the keyboard layouts the codebase is written with, so in practice they arrive by copy-paste or from a generation tool; they cannot be typed back by a reviewer who greps for a comment; and two variants of a translatable literal that differ only in the dash are two terms to translate. The skill files themselves carried 65 of them, plus 4 ellipsis characters. **Current behavior before PR:** - An agent writing or reviewing an addon has no rule on punctuation in comments, docstrings, user-facing strings or commit messages. - The guideline files use the em dash heavily, so an agent reading them picks up the habit from the material that is supposed to correct it. **Desired behavior after PR is merged:** - `odoo-guidelines/guidelines/comments.md` holds one section, registered in the skill table so it is read when a comment, a docstring, a user-facing string or a commit message is written: "Plain ASCII punctuation in comments and messages" states the rule, gives a bad/good example, explains why, and carves out the exceptions (content that is data rather than prose, and stable branches, where fixing punctuation is a cosmetic change and rewording a translatable term breaks its translations). - The guideline files follow their own rule: the 65 em dashes and the 4 ellipsis characters are rewritten as a comma, a colon, a semicolon, parentheses or a new sentence, one by one rather than by a blind substitution. The only occurrences left are in `comments.md`, where the character is the subject of the rule and of its "bad" example. - No guidance changes meaning: the cleanup is punctuation only, so it can be reviewed by reading the word diff (`git show --word-diff=plain`). --- I confirm I have signed the CLA and read the PR guidelines at www.odoo.com/submit-pr Forward-Port-Of: odoo/odoo#288034