iframe-proxy

LantaoJin · 2025-12-11T05:15:36Z

Description

Show backticks in testing-doctest.md

Before:

After:

Related Issues

Resolves #[Issue number to be closed when this PR is merged]

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: Lantao Jin <ltjin@amazon.com>

coderabbitai · 2025-12-11T05:15:42Z

📝 Walkthrough

Summary by CodeRabbit

Documentation
- Enhanced formatting of code block examples in testing documentation for improved clarity and readability.

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

Walkthrough

Markdown code block formatting adjustments to the PPL documentation section in the testing documentation. Code fences are added around sample input and output examples, with explicit "Expected output" labels removed and replaced with corresponding closing fence blocks.

Changes

Cohort / File(s)	Summary
Documentation formatting `docs/dev/testing-doctest.md`	Adjusted Markdown code block fencing in PPL documentation examples; added opening and closing code fence blocks around sample input/output pairs and removed explicit labels

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 '[DOC] Show backticks in testing-doctest.md' directly describes the main change—adding backticks/code fencing to the testing-doctest.md documentation file.
Description check	✅ Passed	The description is related to the changeset, explaining the purpose of showing backticks in the documentation with before/after screenshots demonstrating the visual change.
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 1a3f400 and 9e48ed5.

📒 Files selected for processing (1)

docs/dev/testing-doctest.md (2 hunks)

🧰 Additional context used

🧠 Learnings (1)

📓 Common learnings

Learnt from: CR
Repo: opensearch-project/sql PR: 0
File: .rules/REVIEW_GUIDELINES.md:0-0
Timestamp: 2025-12-02T17:27:55.938Z
Learning: Include edge cases and boundary conditions in PPL parser tests

🔇 Additional comments (3)

docs/dev/testing-doctest.md (3)

78-82: LGTM: PPL code block example formatting is correct.

The quadruple-backtick wrapper properly displays the triple-backtick PPL code block syntax to readers.

86-95: LGTM: Expected output code block example formatting is correct.

The quadruple-backtick wrapper properly displays the table output format with correct text language specifier. The "Expected output:" label clearly identifies the section purpose.

103-107: LGTM: Ignore attribute code block example formatting is correct.

The ppl ignore syntax is clearly demonstrated with proper wrapping and language specifier placement.

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

LantaoJin · 2025-12-11T05:16:05Z

ping @kylehounslow

opensearch-trigger-bot · 2025-12-11T08:32:17Z

Signed-off-by: Lantao Jin <ltjin@amazon.com> (cherry picked from commit c527afc) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

(cherry picked from commit c527afc) Signed-off-by: Lantao Jin <ltjin@amazon.com> Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

Show backticks in testing-doctest.md

9e48ed5

Signed-off-by: Lantao Jin <ltjin@amazon.com>

LantaoJin added the documentation Improvements or additions to documentation label Dec 11, 2025

LantaoJin marked this pull request as ready for review December 11, 2025 05:47

yuancu approved these changes Dec 11, 2025

View reviewed changes

LantaoJin enabled auto-merge (squash) December 11, 2025 07:31

LantaoJin added the backport 2.19-dev label Dec 11, 2025

qianheng-aws approved these changes Dec 11, 2025

View reviewed changes

LantaoJin merged commit c527afc into opensearch-project:main Dec 11, 2025
39 of 41 checks passed

opensearch-trigger-bot Bot added the backport-failed label Dec 11, 2025

LantaoJin added backport 2.19-dev and removed backport-failed backport 2.19-dev labels Dec 12, 2025

opensearch-trigger-bot Bot mentioned this pull request Dec 12, 2025

[Backport 2.19-dev] [DOC] Show backticks in testing-doctest.md #4954

Merged

Sunbelt Computer Software

PL/B Language Development and Support

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

[DOC] Show backticks in testing-doctest.md#4941

[DOC] Show backticks in testing-doctest.md#4941
LantaoJin merged 1 commit into
opensearch-project:mainfrom
LantaoJin:pr/fix_doctest_doc

LantaoJin commented Dec 11, 2025 •

edited

Loading

Uh oh!

coderabbitai Bot commented Dec 11, 2025 •

edited

Loading

Summary by CodeRabbit

Walkthrough

Changes

Estimated code review effort

Uh oh!

LantaoJin commented Dec 11, 2025

Uh oh!

Uh oh!

opensearch-trigger-bot Bot commented Dec 11, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Sunbelt Computer Software

PL/B Language Development and Support

Uh oh!

Conversation

LantaoJin commented Dec 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Related Issues

Check List

Uh oh!

coderabbitai Bot commented Dec 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Walkthrough

Changes

Estimated code review effort

Pre-merge checks and finishing touches

Uh oh!

LantaoJin commented Dec 11, 2025

Uh oh!

Uh oh!

opensearch-trigger-bot Bot commented Dec 11, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

LantaoJin commented Dec 11, 2025 •

edited

Loading

coderabbitai Bot commented Dec 11, 2025 •

edited

Loading