Skip to content

fix(om2.0) : do we really need escaping for escaping? #2900

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
krajorama wants to merge 1 commit into
base: main
Choose a base branch
from
+2 −2
Open

fix(om2.0) : do we really need escaping for escaping? #2900

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/specs/om/open_metrics_spec_2_0.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -625,9 +625,9 @@ Complete example:

#### Escaping

Where the ABNF notes escaping, the following escaping MUST be applied Line feed, `\n` (0x0A) -> literally `\\n` (Bytecode 0x5c 0x6e) Double quotes -> `\\"` (Bytecode 0x5c 0x22) Backslash -> `\\\\` (Bytecode 0x5c 0x5c)
Where the ABNF notes escaping, the following escaping MUST be applied Line feed, `\n` (0x0A) -> literally `\n` (Bytecode 0x5c 0x6e) Double quotes -> `\"` (Bytecode 0x5c 0x22) Backslash -> `\\` (Bytecode 0x5c 0x5c)
Copy link
Member

@bwplotka bwplotka Mar 20, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"Must be applied Line feed" - this reads weird. Is this a valid English?

Also "Where the ABNF notes escaping," - does it mens "when the ABNF defines the use of escaping"? Can we reword?

What about:

Suggested change
Where the ABNF notes escaping, the following escaping MUST be applied Line feed, `\n` (0x0A) -> literally `\n` (Bytecode 0x5c 0x6e) Double quotes -> `\"` (Bytecode 0x5c 0x22) Backslash -> `\\` (Bytecode 0x5c 0x5c)
Where the ABNF notes escaping, the following escaping MUST be applied:
* Line feed, `\n` (0x0A) -> literally `\n` (Bytecode 0x5c 0x6e)
* Double quotes -> `\"` (Bytecode 0x5c 0x22)
* Backslash -> `\\` (Bytecode 0x5c 0x5c)


A double backslash SHOULD be used to represent a backslash character. A single backslash SHOULD NOT be used for undefined escape sequences. As an example, `\\\\a` is equivalent and preferable to `\\a`.
A double backslash SHOULD be used to represent a backslash character. A single backslash SHOULD NOT be used for undefined escape sequences. As an example, `\\a` is equivalent and preferable to `\a`.

Escaping MUST also be applied to quoted UTF-8 strings.

Expand Down
Loading