Conversation
Reviewer's GuideAdded comprehensive documentation for the Markdown stream processor, detailing the internal state machine, helper functions (fences compression, HTML table conversion, text wrapping), and including a Mermaid diagram with links to related documentation. File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
Summary by CodeRabbit
WalkthroughAdded a new documentation file describing the Changes
Estimated code review effort1 (~5 minutes) Possibly related PRs
Poem
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
📓 Path-based instructions (2)docs/**/*.md📄 CodeRabbit Inference Engine (AGENTS.md)
Files:
**/*.md📄 CodeRabbit Inference Engine (AGENTS.md)
Files:
⚙️ CodeRabbit Configuration File
Files:
🪛 LanguageTooldocs/markdown-stream-processor.md[style] ~12-~12: Would you like to use the Oxford spelling “normalize”? The spelling ‘normalise’ is also correct. (OXFORD_SPELLING_Z_NOT_S) [style] ~70-~70: You have used the passive voice repeatedly in nearby sentences. To make your writing clearer and easier to read, consider using active voice. (REP_PASSIVE_VOICE) [uncategorized] ~76-~76: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA) 🧰 Additional context used📓 Path-based instructions (2)docs/**/*.md📄 CodeRabbit Inference Engine (AGENTS.md)
Files:
**/*.md📄 CodeRabbit Inference Engine (AGENTS.md)
Files:
⚙️ CodeRabbit Configuration File
Files:
🪛 LanguageTooldocs/markdown-stream-processor.md[style] ~12-~12: Would you like to use the Oxford spelling “normalize”? The spelling ‘normalise’ is also correct. (OXFORD_SPELLING_Z_NOT_S) [style] ~70-~70: You have used the passive voice repeatedly in nearby sentences. To make your writing clearer and easier to read, consider using active voice. (REP_PASSIVE_VOICE) [uncategorized] ~76-~76: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA) ✨ Finishing Touches🧪 Generate unit tests
🪧 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 (
|
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hey @leynos - I've reviewed your changes - here's some feedback:
- Consider adding a concrete before-and-after Markdown snippet to illustrate how process_stream_inner rewrites a real stream in practice.
- Include the exact function signature or a link to its source in the repo so readers can quickly jump from this doc to the implementation.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- Consider adding a concrete before-and-after Markdown snippet to illustrate how process_stream_inner rewrites a real stream in practice.
- Include the exact function signature or a link to its source in the repo so readers can quickly jump from this doc to the implementation.Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
![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
📜 Review details
Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro
📒 Files selected for processing (1)
docs/markdown-stream-processor.md(1 hunks)
📓 Path-based instructions (2)
docs/**/*.md
📄 CodeRabbit Inference Engine (AGENTS.md)
docs/**/*.md: Reference: Use the markdown files within thedocs/directory as a knowledge base and source of truth for project requirements, dependency choices, and architectural decisions.
Update: When new decisions are made, requirements change, libraries are added/removed, or architectural patterns evolve, proactively update the relevant file(s) in thedocs/directory to reflect the latest state.
Documentation must use en-GB-oxendict spelling and grammar (with the exception of "license" which is to be left unchanged for community consistency).
Files:
docs/markdown-stream-processor.md
**/*.md
📄 CodeRabbit Inference Engine (AGENTS.md)
**/*.md: Validate Markdown files usingmake markdownlint.
Runmake fmtafter any documentation changes to format all Markdown files and fix table markup.
Validate Mermaid diagrams in Markdown files by runningmake nixie.
Markdown paragraphs and bullet points must be wrapped at 80 columns.
Code blocks must be wrapped at 120 columns.
Tables and headings must not be wrapped.
Use dashes (-) for list bullets.
Use GitHub-flavoured Markdown footnotes ([^1]) for references.
Files:
docs/markdown-stream-processor.md
⚙️ CodeRabbit Configuration File
**/*.md: * Avoid 2nd person or 1st person pronouns ("I", "you", "we")
- Use en-GB-oxendict (-ize / -our) spelling and grammar
- Paragraphs and bullets must be wrapped to 80 columns, except where a long URL would prevent this (in which case, silence MD013 for that line)
- Code blocks should be wrapped to 120 columns.
- Headings must not be wrapped.
- Documents must start with a level 1 heading
- Headings must correctly increase or decrease by no more than one level at a time
- Use GitHub-flavoured Markdown style for footnotes and endnotes.
- Numbered footnotes must be numbered by order of appearance in the document.
Files:
docs/markdown-stream-processor.md
🪛 LanguageTool
docs/markdown-stream-processor.md
[style] ~6-~6: Would you like to use the Oxford spelling “normalize”? The spelling ‘normalise’ is also correct.
Context: ..._fencesandattach_orphan_specifiersnormalise code block delimiters. -html::conve...
(OXFORD_SPELLING_Z_NOT_S)
[uncategorized] ~46-~46: Possible missing comma found.
Context: ...fence delimiter ``` After scanning all lines the processor performs optional post-pr...
(AI_HYDRA_LEO_MISSING_COMMA)
🧰 Additional context used
📓 Path-based instructions (2)
docs/**/*.md
📄 CodeRabbit Inference Engine (AGENTS.md)
docs/**/*.md: Reference: Use the markdown files within thedocs/directory as a knowledge base and source of truth for project requirements, dependency choices, and architectural decisions.
Update: When new decisions are made, requirements change, libraries are added/removed, or architectural patterns evolve, proactively update the relevant file(s) in thedocs/directory to reflect the latest state.
Documentation must use en-GB-oxendict spelling and grammar (with the exception of "license" which is to be left unchanged for community consistency).
Files:
docs/markdown-stream-processor.md
**/*.md
📄 CodeRabbit Inference Engine (AGENTS.md)
**/*.md: Validate Markdown files usingmake markdownlint.
Runmake fmtafter any documentation changes to format all Markdown files and fix table markup.
Validate Mermaid diagrams in Markdown files by runningmake nixie.
Markdown paragraphs and bullet points must be wrapped at 80 columns.
Code blocks must be wrapped at 120 columns.
Tables and headings must not be wrapped.
Use dashes (-) for list bullets.
Use GitHub-flavoured Markdown footnotes ([^1]) for references.
Files:
docs/markdown-stream-processor.md
⚙️ CodeRabbit Configuration File
**/*.md: * Avoid 2nd person or 1st person pronouns ("I", "you", "we")
- Use en-GB-oxendict (-ize / -our) spelling and grammar
- Paragraphs and bullets must be wrapped to 80 columns, except where a long URL would prevent this (in which case, silence MD013 for that line)
- Code blocks should be wrapped to 120 columns.
- Headings must not be wrapped.
- Documents must start with a level 1 heading
- Headings must correctly increase or decrease by no more than one level at a time
- Use GitHub-flavoured Markdown style for footnotes and endnotes.
- Numbered footnotes must be numbered by order of appearance in the document.
Files:
docs/markdown-stream-processor.md
🪛 LanguageTool
docs/markdown-stream-processor.md
[style] ~6-~6: Would you like to use the Oxford spelling “normalize”? The spelling ‘normalise’ is also correct.
Context: ..._fencesandattach_orphan_specifiersnormalise code block delimiters. -html::conve...
(OXFORD_SPELLING_Z_NOT_S)
[uncategorized] ~46-~46: Possible missing comma found.
Context: ...fence delimiter ``` After scanning all lines the processor performs optional post-pr...
(AI_HYDRA_LEO_MISSING_COMMA)
⏰ Context from checks skipped due to timeout of 240000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: build-test
| - `fences::compress_fences` and `attach_orphan_specifiers` normalise code block | ||
| delimiters. |
There was a problem hiding this comment.
🧹 Nitpick (assertive)
Enforce Oxford-ise spelling (“-ize” suffix).
Project guidelines dictate en-GB-oxendict spelling, which prefers “-ize”.
Replace “normalise” with “normalize”.
- `fences::compress_fences` and `attach_orphan_specifiers` normalise code block
+ `fences::compress_fences` and `attach_orphan_specifiers` normalize code block📝 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.
| - `fences::compress_fences` and `attach_orphan_specifiers` normalise code block | |
| delimiters. | |
| - `fences::compress_fences` and `attach_orphan_specifiers` normalize code block | |
| delimiters. |
🧰 Tools
🪛 LanguageTool
[style] ~6-~6: Would you like to use the Oxford spelling “normalize”? The spelling ‘normalise’ is also correct.
Context: ..._fencesandattach_orphan_specifiersnormalise code block delimiters. -html::conve...
(OXFORD_SPELLING_Z_NOT_S)
🤖 Prompt for AI Agents
In docs/markdown-stream-processor.md around lines 6 to 7, replace the word
"normalise" with "normalize" to enforce the Oxford-ise spelling as per project
guidelines that prefer the "-ize" suffix.
| InCodeFence --> Streaming: Line is a fence delimiter | ||
| ``` | ||
|
|
||
| After scanning all lines the processor performs optional post-processing steps |
There was a problem hiding this comment.
🧹 Nitpick (assertive)
Insert the missing comma after an introductory clause.
Add a comma after “lines” to satisfy grammatical rules and silence the
LanguageTool warning.
-After scanning all lines the processor performs optional post-processing steps
+After scanning all lines, the processor performs optional post-processing steps📝 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.
| After scanning all lines the processor performs optional post-processing steps | |
| After scanning all lines, the processor performs optional post-processing steps |
🧰 Tools
🪛 LanguageTool
[uncategorized] ~46-~46: Possible missing comma found.
Context: ...fence delimiter ``` After scanning all lines the processor performs optional post-pr...
(AI_HYDRA_LEO_MISSING_COMMA)
🤖 Prompt for AI Agents
In docs/markdown-stream-processor.md at line 46, add a comma after the word
"lines" in the sentence "After scanning all lines the processor performs
optional post-processing steps" to correctly separate the introductory clause
and fix the grammatical error.
|
Superseded. |
1 participant
Summary
process_stream_innerstate machineTesting
make lintmake testmake markdownlintmake nixiehttps://chatgpt.com/codex/tasks/task_e_687ebf1387c08322988e30d351ad8546
Summary by Sourcery
Add documentation for the Markdown stream processor
Documentation: