update docs with PR Stage and others #336
Conversation
WalkthroughThe documentation for custom reports was updated to introduce a new Changes
Poem
Tip ⚡️ Faster reviews with caching
Enjoy the performance boost—your workflow just got faster. 📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
⏰ Context from checks skipped due to timeout of 90000ms (2)
✨ Finishing Touches
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
Deploying coderabbit-docs with
|
| Latest commit: |
d576a39
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://b9888963.coderabbit-docs.pages.dev |
| Branch Preview URL: | https://update-custom-reporting-data.coderabbit-docs.pages.dev |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Caution
Inline review comments failed to post. This is likely due to GitHub's limits when posting large numbers of comments. If you are seeing this consistently it is likely a permissions issue. Please check "Moderation" -> "Code review limits" under your organization settings.
Actionable comments posted: 2
🧹 Nitpick comments (7)
docs/guides/custom-reports.md (7)
79-83: ClarifyundefinedPR Stage representationUsing
undefinedas a literal value in documentation may confuse readers—it’s unclear if it’s meant to indicate omission or literally the string"undefined". Consider:
- Replacing
undefinedwith a clearer placeholder such asN/AorNone- Wrapping all stage values in backticks for consistency (e.g.,
`Needs Author Action`)
146-148: Standardize example placeholder punctuationThe placeholders include trailing periods, which may lead to double punctuation in generated output. Consider removing them:
- **Summary:** Summary of the PR. - **Comments:** Summary of the PR comments or No Comments. + **Summary:** Summary of the PR + **Comments:** Summary of the PR comments or No Comments
154-156: Align placeholder formatting in second exampleStrip trailing periods from
SummaryandCommentsplaceholders for uniformity:- **Summary:** Summary of the PR. - **Comments:** Summary of the PR comments or No Comments. + **Summary:** Summary of the PR + **Comments:** Summary of the PR comments or No Comments
161-162: Clean up placeholders in merged exampleRemove trailing periods from the
SummaryandCommentsplaceholders:- **Summary:** Summary of the PR. - **Comments:** Summary of the PR comments or No Comments. + **Summary:** Summary of the PR + **Comments:** Summary of the PR comments or No Comments
173-176: Standardize merged PR (#13005) exampleMinor cleanup—strip trailing periods from placeholders:
- **Summary:** Summary of the PR. - **Comments:** Summary of the PR comments or No Comments. + **Summary:** Summary of the PR + **Comments:** Summary of the PR comments or No Comments
179-182: Standardize merged PR (#3006) exampleSame placeholder adjustment for consistency:
- **Summary:** Summary of the PR. - **Comments:** Summary of the PR comments or No Comments. + **Summary:** Summary of the PR + **Comments:** Summary of the PR comments or No Comments
185-190: Cleanup draft PR (#3007) exampleRemove quotes around the stage value and strip periods in placeholders:
- **PR Stage:** "Needs Author Action" - **Summary:** Summary of the PR. - **Comments:** Summary of the PR comments or No Comments. + **PR Stage:** Needs Author Action + **Summary:** Summary of the PR + **Comments:** Summary of the PR comments or No Comments
🛑 Comments failed to post (2)
docs/guides/custom-reports.md (2)
135-136: 🛠️ Refactor suggestion
Clarify when to display Mergeable and PR Stage
The condition (“if PR State is not 'Merged'”) also includes closed/declined PRs. For precision, revise to:
“If PR State is 💬 Open or 📝 Draft, show Mergeable and PR Stage.”
Also wrap status labels in backticks.🤖 Prompt for AI Agents (early access)
In docs/guides/custom-reports.md around lines 135 to 136, update the condition for displaying Mergeable and PR Stage to specify "If PR State is `Open` or `Draft`" instead of "if PR State is not 'Merged'". Also, wrap the status labels "Mergeable" and "PR Stage" in backticks to format them as code.
167-170: 🛠️ Refactor suggestion
Reorder fields and remove quotes in #14 example
Per the spec,
Mergeableshould come beforePR Stage, and the stage value shouldn’t be quoted. Apply this diff:- **PR Stage:** "Needs Author Action" - **Mergeable:** Mergeable + **Mergeable:** Mergeable + **PR Stage:** Needs Author Action📝 Committable suggestion
‼️ 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.- **Mergeable:** Mergeable - **PR Stage:** Needs Author Action - **Summary:** Summary of the PR. - **Comments:** Summary of the PR comments or No Comments.🤖 Prompt for AI Agents (early access)
In docs/guides/custom-reports.md around lines 167 to 170, reorder the fields so that "Mergeable" appears before "PR Stage" and remove the quotes around the stage value in the #14 example. Adjust the lines to reflect this correct order and formatting as per the specification.
No description provided.