Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
📝 WalkthroughWalkthroughAdds a new Plane Query Language (PQL) documentation page and updates the site sidebar to include a link to that page under "Views and layouts." No other code or public API changes. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
📝 Coding Plan
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. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (1)
docs/core-concepts/issues/plane-query-language.md (1)
62-62: Normalize operator casing in examples for consistency.Line 62 uses lowercase
in, while the operator reference tables standardize on uppercaseIN/NOT IN. Keeping example casing aligned improves readability and reduces ambiguity.Proposed consistency tweak
-(priority = High AND state in (Backlog, In Progress, Todo)) OR (type in (Bug, Task, Improvements) AND assignee in (Ethan, Parker, Amanda)) +(priority = High AND state IN (Backlog, In Progress, Todo)) OR (type IN (Bug, Task, Improvements) AND assignee IN (Ethan, Parker, Amanda))🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/core-concepts/issues/plane-query-language.md` at line 62, Update the example expression that currently uses lowercase operators by replacing the lowercase "in" with the standardized uppercase "IN" (e.g., change "(priority = High AND state in (Backlog, In Progress, Todo)) OR (type in (Bug, Task, Improvements) AND assignee in (Ethan, Parker, Amanda))" to use "IN" and "NOT IN" casing where applicable) so it matches the operator reference tables and maintains consistency across examples.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/core-concepts/issues/plane-query-language.md`:
- Around line 1-341: The CI is failing due to OXFMT formatting on the Plane
Query Language doc; run the formatter and commit the changes by running "oxfmt
--write docs/core-concepts/issues/plane-query-language.md", review the updated
formatting in the "Plane Query Language" file, stage the modified file, and
create a new commit so the pipeline's OXFMT check passes.
- Around line 33-63: Add the markdown language identifier "pql" to each
unlabeled fenced code block so markdownlint MD040 is satisfied: update the five
code fences that contain the snippets "Field Operator Value", "priority = High",
"type = Bug AND priority = High", "state = Todo OR state = In Progress", and the
combined query "(priority = High AND state in (Backlog, In Progress, Todo)) OR
(type in (Bug, Task, Improvements) AND assignee in (Ethan, Parker, Amanda))" to
use ```pql instead of plain ```; no other content changes required.
---
Nitpick comments:
In `@docs/core-concepts/issues/plane-query-language.md`:
- Line 62: Update the example expression that currently uses lowercase operators
by replacing the lowercase "in" with the standardized uppercase "IN" (e.g.,
change "(priority = High AND state in (Backlog, In Progress, Todo)) OR (type in
(Bug, Task, Improvements) AND assignee in (Ethan, Parker, Amanda))" to use "IN"
and "NOT IN" casing where applicable) so it matches the operator reference
tables and maintains consistency across examples.
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 479963f5-7e5c-4c63-ba31-1946690176c5
📒 Files selected for processing (2)
docs/.vitepress/config.tsdocs/core-concepts/issues/plane-query-language.md
| ``` | ||
| Field Operator Value | ||
| ``` | ||
|
|
||
| Example: | ||
| ``` | ||
| priority = High | ||
| ``` | ||
|
|
||
| This returns all work items where priority is High. | ||
|
|
||
| You can also combine multiple conditions using logical operators like `AND` and `OR`. | ||
|
|
||
| **Using AND** | ||
| ``` | ||
| type = Bug AND priority = High | ||
| ``` | ||
|
|
||
| This returns work items that match both conditions. | ||
|
|
||
| **Using OR** | ||
| ``` | ||
| state = Todo OR state = In Progress | ||
| ``` | ||
|
|
||
| This returns work items that match either condition. | ||
|
|
||
| **Combined:** | ||
| ``` | ||
| (priority = High AND state in (Backlog, In Progress, Todo)) OR (type in (Bug, Task, Improvements) AND assignee in (Ethan, Parker, Amanda)) | ||
| ``` |
There was a problem hiding this comment.
Add language identifiers to fenced code blocks (MD040).
Line 33, Line 38, Line 47, Line 54, and Line 61 use unlabeled fences, which is triggering markdownlint warnings.
Proposed doc fix
-```
+```pql
Field Operator Value- +pql
priority = High
-```
+```pql
type = Bug AND priority = High
- +pql
state = Todo OR state = In Progress
-```
+```pql
(priority = High AND state in (Backlog, In Progress, Todo)) OR (type in (Bug, Task, Improvements) AND assignee in (Ethan, Parker, Amanda))
</details>
<!-- suggestion_start -->
<details>
<summary>📝 Committable suggestion</summary>
> ‼️ **IMPORTANT**
> Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
```suggestion
🧰 Tools
🪛 markdownlint-cli2 (0.21.0)
[warning] 33-33: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
[warning] 38-38: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
[warning] 47-47: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
[warning] 54-54: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
[warning] 61-61: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/core-concepts/issues/plane-query-language.md` around lines 33 - 63, Add
the markdown language identifier "pql" to each unlabeled fenced code block so
markdownlint MD040 is satisfied: update the five code fences that contain the
snippets "Field Operator Value", "priority = High", "type = Bug AND priority =
High", "state = Todo OR state = In Progress", and the combined query "(priority
= High AND state in (Backlog, In Progress, Todo)) OR (type in (Bug, Task,
Improvements) AND assignee in (Ethan, Parker, Amanda))" to use ```pql instead of
plain ```; no other content changes required.
There was a problem hiding this comment.
♻️ Duplicate comments (1)
docs/core-concepts/issues/plane-query-language.md (1)
33-67:⚠️ Potential issue | 🟡 MinorAdd language identifiers to code blocks (markdownlint MD040).
The five code blocks in this section still lack language identifiers, which triggers linting warnings. Adding
pqlas the language identifier will resolve the MD040 warnings.📝 Proposed fix
-``` +```pql Field Operator ValueExample:
-
+pql
priority = High... **Using AND** -``` +```pql type = Bug AND priority = High...
Using OR
-
+pql
state = Todo OR state = In Progress... **Combined:** -``` +```pql (priority = High AND state in (Backlog, In Progress, Todo)) OR (type in (Bug, Task, Improvements) AND assignee in (Ethan, Parker, Amanda))</details> <details> <summary>🤖 Prompt for AI Agents</summary>Verify each finding against the current code and only fix it if needed.
In
@docs/core-concepts/issues/plane-query-language.mdaround lines 33 - 67, In
plane-query-language.md update the five fenced code blocks to include the pql
language identifier: change the opening fences for the blocks containing "Field
Operator Value", "priority = High", "type = Bug AND priority = High", "state =
Todo OR state = In Progress", and the combined query "(priority = High AND state
in (Backlog, In Progress, Todo)) OR (type in (Bug, Task, Improvements) AND
assignee in (Ethan, Parker, Amanda))" fromtopql so markdownlint MD040
warnings are resolved.</details> </blockquote></details> </blockquote></details> <details> <summary>🤖 Prompt for all review comments with AI agents</summary>Verify each finding against the current code and only fix it if needed.
Duplicate comments:
In@docs/core-concepts/issues/plane-query-language.md:
- Around line 33-67: In plane-query-language.md update the five fenced code
blocks to include the pql language identifier: change the opening fences for the
blocks containing "Field Operator Value", "priority = High", "type = Bug AND
priority = High", "state = Todo OR state = In Progress", and the combined query
"(priority = High AND state in (Backlog, In Progress, Todo)) OR (type in (Bug,
Task, Improvements) AND assignee in (Ethan, Parker, Amanda))" fromtopql
so markdownlint MD040 warnings are resolved.</details> --- <details> <summary>ℹ️ Review info</summary> <details> <summary>⚙️ Run configuration</summary> **Configuration used**: defaults **Review profile**: CHILL **Plan**: Pro **Run ID**: `773cf5ad-b0a2-4119-8f9c-7b0e74abd114` </details> <details> <summary>📥 Commits</summary> Reviewing files that changed from the base of the PR and between cfad00e93ec335e7e62b0eb6931a6f371598a20b and 3114997674bce08d5f8843e80db8e632bb7b2833. </details> <details> <summary>⛔ Files ignored due to path filters (1)</summary> * `pnpm-lock.yaml` is excluded by `!**/pnpm-lock.yaml` </details> <details> <summary>📒 Files selected for processing (1)</summary> * `docs/core-concepts/issues/plane-query-language.md` </details> </details> <!-- This is an auto-generated comment by CodeRabbit for review status -->
1 participant
Description
Type of Change
Screenshots and Media (if applicable)
Test Scenarios
References
Summary by CodeRabbit