fix: Fix formatting of configuration table in README.md#27
fix: Fix formatting of configuration table in README.md#27jeanplevesque merged 1 commit intomainfrom
Conversation
|
Caution Review failedThe pull request is closed. WalkthroughDocumentation fix to README.md escaping a pipe character in a markdown table cell to ensure correct parsing, with minor alignment adjustments. No semantic changes to configuration values or behavior. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes ✨ Finishing touches🧪 Generate unit tests (beta)
📜 Recent review detailsConfiguration used: Organization UI Review profile: CHILL Plan: Pro 📒 Files selected for processing (1)
✏️ Tip: You can disable this entire section by setting 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 |
There was a problem hiding this comment.
Pull request overview
This PR fixes a markdown table formatting issue where the pipe character in url|branch was breaking the table structure. The fix escapes the pipe character as url\|branch.
Changes:
- Escaped the pipe character in the
promptitude.repositoriesdescription to prevent it from being interpreted as a table column separator
| | `promptitude.syncOnStartup` | Sync when VS Code starts | `true` | boolean | | ||
| | `promptitude.showNotifications` | Show sync status notifications | `true` | boolean | | ||
| | `promptitude.syncChatmode` | Sync agent prompts (supports both agents/ and legacy chatmodes/ directories) | `true` | boolean | | ||
| | `promptitude.syncChatmode` | Sync agent prompts (supports both agents/ and legacy chatmodes/ directories) | `true` | boolean | |
There was a problem hiding this comment.
The table column alignment is broken on this line. The Default column value appears truncated or the spacing is incorrect compared to other rows in the table. The Default value should maintain consistent padding with other rows (should be "| true | boolean |" to match the column width of ~70 characters).
| | `promptitude.frequency` | Sync frequency | `"daily"` | string | | ||
| | `promptitude.customPath` | Custom prompts directory path | `""` | string | | ||
| | `promptitude.repositories` | Repositories with optional branch (use `url` or `url|branch`) | `[]` | array | | ||
| | `promptitude.repositories` | Repositories with optional branch (use `url` or `url\|branch`) | `[]` | array | |
There was a problem hiding this comment.
The table column alignment is broken on this line. The Default column value appears truncated or the spacing is incorrect compared to other rows in the table. The Default value should maintain consistent padding with other rows (should be "| [] | array |" to match the column width of ~70 characters).
The
url|branchpart was breaking the table row. It's now fixed by escaping the|.Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.