Skip to content

docs: Update the CLP link in the docstring to match its new docs site structure from y-scope/clp#1155. - #51

Merged
anlowee merged 2 commits into
y-scope:release-0.293-clp-connectorfrom
quinntaylormitchell:docs-restructure-rename-presto
Sep 5, 2025
Merged

docs: Update the CLP link in the docstring to match its new docs site structure from y-scope/clp#1155.#51
anlowee merged 2 commits into
y-scope:release-0.293-clp-connectorfrom
quinntaylormitchell:docs-restructure-rename-presto

Conversation

@quinntaylormitchell

@quinntaylormitchell quinntaylormitchell commented Aug 4, 2025

Copy link
Copy Markdown

Description

PR #1155 in y-scope/clp changes user-guide to user-docs. This PR modifies the single instance of user-guide in this repo to user-docs to comply.

Do not merge this PR until PR #1155 is merged.

Checklist

  • The PR satisfies the contribution guidelines.
  • This is a breaking change and that has been indicated in the PR title, OR this isn't a
    breaking change.
  • Necessary docs have been updated, OR no docs need to be updated.

Validation performed

N/A

Summary by CodeRabbit

  • Documentation
    • Updated a URL in the documentation to point to the correct reference page.

@quinntaylormitchell quinntaylormitchell changed the title docs: Rename user-guide to user-docs, as per CLP docs PR clp: Rename user-guide to user-docs, as per CLP docs PR Aug 4, 2025
@quinntaylormitchell quinntaylormitchell changed the title clp: Rename user-guide to user-docs, as per CLP docs PR chore(clp): Rename user-guide to user-docs, as per CLP docs PR Aug 4, 2025
@quinntaylormitchell
quinntaylormitchell marked this pull request as ready for review August 4, 2025 17:36
@coderabbitai

coderabbitai Bot commented Aug 4, 2025

Copy link
Copy Markdown

Walkthrough

A single Javadoc comment was updated in the ClpFilterToKqlConverter.java file, correcting the URL in the documentation for the escapeKqlSpecialCharsForStringValue method. No changes were made to the code logic or public entity declarations.

Changes

Cohort / File(s) Change Summary
Javadoc URL Correction
presto-clp/.../ClpFilterToKqlConverter.java
Updated the Javadoc URL in the comment for escapeKqlSpecialCharsForStringValue to the correct documentation link.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~1 minute

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.


📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between a6e3590 and c9ae3f3.

📒 Files selected for processing (1)
  • presto-clp/src/main/java/com/facebook/presto/plugin/clp/ClpFilterToKqlConverter.java (1 hunks)
🧰 Additional context used
🧠 Learnings (1)
📓 Common learnings
Learnt from: anlowee
PR: y-scope/presto#7
File: .github/workflows/hive-tests.yml:33-35
Timestamp: 2025-06-04T14:50:43.554Z
Learning: In the y-scope/presto repository, GitHub workflows are extended from OSS Presto and should maintain consistent formatting with the upstream patterns, including YAML indentation styles for workflow steps.
🔇 Additional comments (1)
presto-clp/src/main/java/com/facebook/presto/plugin/clp/ClpFilterToKqlConverter.java (1)

887-890: URL rename aligns with upstream—verify target is live before merge

The Javadoc now references …/user-docs/…, matching the planned rename in the CLP repo. Looks correct. Just confirm PR prestodb#1155 in y-scope/clp is merged and the URL resolves, then this can go in safely.

✨ Finishing Touches
  • 📝 Generate Docstrings
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment

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
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai generate unit tests to generate unit tests for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@anlowee

anlowee commented Sep 5, 2025

Copy link
Copy Markdown

For the PR title, how about:

docs: Update the CLP link in the docstring to match its new docs site structure from y-scope/clp#1155.

@quinntaylormitchell quinntaylormitchell changed the title chore(clp): Rename user-guide to user-docs, as per CLP docs PR docs: Update the CLP link in the docstring to match its new docs site structure from y-scope/clp#1155. Sep 5, 2025
@anlowee
anlowee merged commit a07fe2f into y-scope:release-0.293-clp-connector Sep 5, 2025
29 checks passed
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