Skip to content

fix(om2): clarify empty UNIT/HELP value wording#2931

Merged
bwplotka merged 1 commit intomainfrom
krajo/om2-empty-unit-help
Mar 30, 2026
Merged

fix(om2): clarify empty UNIT/HELP value wording#2931
bwplotka merged 1 commit intomainfrom
krajo/om2-empty-unit-help

Conversation

@krajorama
Copy link
Copy Markdown
Member

Summary

  • Replaces "The value of a UNIT or HELP line MAY be empty." with more precise wording specifying that the empty value string appears before the newline
  • Aligns second sentence with standard spec language ("were not present" instead of "no metadata line existed")

Test plan

  • Verify the change renders correctly in the docs site

Signed-off-by: György Krajcsovits gyorgy.krajcsovits@grafana.com

🤖 Coded with Claude Sonnet 4.6. Generated with Claude Code

Be more precise about where the empty value appears (before the newline)
and align with standard spec language.

Signed-off-by: György Krajcsovits <gyorgy.krajcsovits@grafana.com>
Coded with Claude Sonnet 4.6.
Copy link
Copy Markdown
Member

@bwplotka bwplotka left a comment

Choose a reason for hiding this comment

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

LGTM, optional nit

If the unit is known it SHOULD be provided.

The value of a UNIT or HELP line MAY be empty. This MUST be treated as if no metadata line for the MetricFamily existed.
A UNIT or HELP metadata line MAY have an empty value string before the newline. This MUST be treated as if the metadata line were not present.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I'd prefer if we simplify, but it's ok.

Suggested change
A UNIT or HELP metadata line MAY have an empty value string before the newline. This MUST be treated as if the metadata line were not present.
A UNIT or HELP metadata line MAY have an empty value. This MUST be treated as if the metadata line were not present.

@bwplotka bwplotka merged commit 15ec08d into main Mar 30, 2026
7 checks passed
@bwplotka bwplotka deleted the krajo/om2-empty-unit-help branch March 30, 2026 13:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants