From 0a630c5ee8c65dd349ab343949dba8150e4b3e53 Mon Sep 17 00:00:00 2001 From: Laurent Monin Date: Sun, 24 Sep 2023 13:20:01 +0200 Subject: [PATCH] Clarification --- CONTRIBUTING.md | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 521286f3c88..7e97eedb52f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -97,12 +97,16 @@ print(d['small']) In above example, `l1` contains identifiers (keys of dict `d`) while others are English words/phrases. In the dict declaration, keys are single-quoted but values are double-quoted. -Otherwise, choose whichever limit the number of escaped characters. - -Note: URIs (and paths used in URIs) should be, in general, enclosed in double quotes, +URIs (and paths used in URIs) should be, in general, enclosed in double quotes, mainly because single quotes can appear in URI, unencoded, as sub-delimiters as specified by [RFC3986](https://www.rfc-editor.org/rfc/rfc3986#section-2.2). +HTML/XML code often contains attributes that are enclosed by double quotes, so in this case, +better use single quotes, e.g. `html = 'text'`. + +In doubt, choose whichever limit the number of escaped characters. +Typically single quote strings that are meant to contain double quotes (e.g. `'The file is "{file}"'`). + ## Git Work-flow