Skip to content

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

Merged
LantaoJin merged 1 commit into
opensearch-project:mainfrom
LantaoJin:pr/fix_doctest_doc
Dec 11, 2025
Merged

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

Conversation

@LantaoJin

@LantaoJin LantaoJin commented Dec 11, 2025

Copy link
Copy Markdown
Member

Description

Show backticks in testing-doctest.md

Before:
Screenshot 2025-12-11 at 1 14 09 PM

After:
Screenshot 2025-12-11 at 1 14 56 PM

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

coderabbitai Bot commented Dec 11, 2025

Copy link
Copy Markdown
Contributor
📝 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 LantaoJin added the documentation Improvements or additions to documentation label Dec 11, 2025
@LantaoJin

Copy link
Copy Markdown
Member Author

ping @kylehounslow

@LantaoJin LantaoJin enabled auto-merge (squash) December 11, 2025 07:31
@LantaoJin LantaoJin merged commit c527afc into opensearch-project:main Dec 11, 2025
39 of 41 checks passed
@opensearch-trigger-bot

Copy link
Copy Markdown
Contributor

The backport to 2.19-dev failed:

The process '/usr/bin/git' failed with exit code 128

To backport manually, run these commands in your terminal:

# Navigate to the root of your repository
cd $(git rev-parse --show-toplevel)
# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add ../.worktrees/sql/backport-2.19-dev 2.19-dev
# Navigate to the new working tree
pushd ../.worktrees/sql/backport-2.19-dev
# Create a new branch
git switch --create backport/backport-4941-to-2.19-dev
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 c527afc0f0e7868068b69a05c521cf1ee7c70334
# Push it to GitHub
git push --set-upstream origin backport/backport-4941-to-2.19-dev
# Go back to the original working tree
popd
# Delete the working tree
git worktree remove ../.worktrees/sql/backport-2.19-dev

Then, create a pull request where the base branch is 2.19-dev and the compare/head branch is backport/backport-4941-to-2.19-dev.

opensearch-trigger-bot Bot pushed a commit that referenced this pull request Dec 12, 2025
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>
LantaoJin pushed a commit that referenced this pull request Dec 12, 2025
(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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

backport 2.19-dev documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants