Skip to content

doc: Fix Markdown formatting in expression language specification - #293

Open
wForget wants to merge 2 commits into
apache:mainfrom
wForget:doc_fix
Open

doc: Fix Markdown formatting in expression language specification#293
wForget wants to merge 2 commits into
apache:mainfrom
wForget:doc_fix

Conversation

@wForget

@wForget wForget commented Jul 30, 2026

Copy link
Copy Markdown
Member

Summary

Fix Markdown rendering issues in core-spec/expression_language.md:

  • Escape the || concatenation operator inside Markdown tables to prevent it from being interpreted as a column separator.
  • Add spacing before section dividers so they render correctly.
  • Make no semantic changes to the expression language specification.

Related Issues

Validation

before:
image
image
image
image

after:
image
image
image
image

Copilot AI review requested due to automatic review settings July 30, 2026 07:20
@wForget wForget changed the title fix: escape pipe character in expression language documentation doc: Fix Markdown formatting in expression language specification Jul 30, 2026

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Pull request overview

Improves Markdown rendering in the expression language specification by adjusting table content and section spacing so the document renders correctly on GitHub without changing the intended semantics.

Changes:

  • Added blank lines before horizontal rules to ensure section dividers render properly.
  • Updated occurrences of the || concatenation operator within Markdown tables to avoid being interpreted as a column separator.
Comments suppressed due to low confidence (1)

core-spec/expression_language.md:668

  • This table cell will render the backslashes literally because it is inside an inline code span (showing a \\|\\| b instead of a || b). Use a <code> tag with &#124; entities to keep the displayed syntax correct without breaking the Markdown table.
| String concat | `CONCAT(a, b)` | `CONCAT(a, b)` | `CONCAT(a, b)` | `CONCAT(a, b)` | `a \|\| b` |

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

| :---- | :---- | :---- |
| `CONCAT` | `CONCAT(str1, str2, ...)` | Concatenate strings |
| `||` | `str1 || str2` | Concatenation operator |
| `\|\|` | `str1 \|\| str2` | Concatenation operator |

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Reference: GFM Spec, §4.10 Tables, Example 200, which explicitly states that pipes can be escaped inside other inline spans and shows `\|` rendering as <code>|</code>.

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.

2 participants