Skip to content

Escape underscore character in documentation for LIKE#4958

Merged
penghuo merged 1 commit intoopensearch-project:mainfrom
Blitheness:patch-1
Dec 15, 2025
Merged

Escape underscore character in documentation for LIKE#4958
penghuo merged 1 commit intoopensearch-project:mainfrom
Blitheness:patch-1

Conversation

@Blitheness
Copy link
Copy Markdown
Contributor

Description

Properly escape underscore character in documentation for LIKE so it doesn't render as italicised text.

Related Issues

NA

Check List

  • New functionality includes testing.
  • New functionality has been documented.
  • New functionality has javadoc added.
  • New functionality has a user manual doc added.
  • New PPL command checklist all confirmed.
  • API changes companion pull request created.
  • Commits are signed per the DCO using --signoff or -s.
  • Public documentation issue/PR created.

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

Signed-off-by: Andy P. <19779808+Blitheness@users.noreply.github.com>
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Dec 15, 2025

📝 Walkthrough

Summary by CodeRabbit

Release Notes

  • Documentation
    • Enhanced the "Pattern Matching with Underscore" documentation example by correcting markdown character escaping to ensure proper rendering and clarity.

✏️ Tip: You can customize this high-level summary in your review settings.

Walkthrough

Documentation update to the WHERE command reference that escapes underscore characters in markdown text to prevent unintended emphasis formatting, and adds a trailing newline to the file.

Changes

Cohort / File(s) Change Summary
Documentation formatting
docs/user/ppl/cmd/where.md
Escaped underscore characters in "Pattern Matching with Underscore" example text to prevent markdown interpretation as emphasis; added trailing newline.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and specifically describes the main change: escaping underscore characters in documentation for the LIKE operator to prevent markdown italics rendering.
Description check ✅ Passed The description accurately explains the purpose of the change (preventing underscore from rendering as italicized text) and relates directly to the documentation update in the changeset.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

📜 Recent review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between ccdb0f7 and 12f30bf.

📒 Files selected for processing (1)
  • docs/user/ppl/cmd/where.md (2 hunks)
🔇 Additional comments (2)
docs/user/ppl/cmd/where.md (2)

57-58: Underscore escaping applied correctly to prevent markdown emphasis formatting.

The escapes on \_ properly ensure that the underscore character is rendered literally rather than as an emphasis delimiter in the markdown output. This correctly addresses the stated objective of the PR.


207-207: Trailing newline addition is appropriate housekeeping.

Adding a trailing newline at end-of-file follows standard markdown file conventions.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown
Collaborator

@penghuo penghuo left a comment

Choose a reason for hiding this comment

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

Thanks!

@penghuo penghuo added documentation Improvements or additions to documentation PPL Piped processing language labels Dec 15, 2025
@penghuo penghuo enabled auto-merge (squash) December 15, 2025 16:35
@penghuo penghuo merged commit fd4b257 into opensearch-project:main Dec 15, 2025
39 of 40 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation PPL Piped processing language

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants