Restore missing footnotes #26
Conversation
Reviewer's GuideThis PR restores and enriches the guide’s reference citations by re-adding previously omitted footnotes and introducing new references to external resources, updating inline citation markers and the footnotes section accordingly. File-Level Changes
Possibly linked issues
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
Summary by CodeRabbit
WalkthroughUpdate the documentation to include new references, citations, and improved formatting in the behavioural testing guide. Add footnotes, expand source attributions, clarify existing citations, and enhance bibliographic consistency. Make minor textual adjustments to insert citation markers. Do not alter any functional or logical content. Changes
Possibly related PRs
Poem
✨ 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 (
|
![codescene-delta-analysis[bot]](https://avatars.githubusercontent.com/in/53921?s=60&v=4){kind=small}
![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:
- Please ensure all footnote reference numbers are sequential and each [^n] tag has a single matching definition to avoid out-of-order or missing citations.
- Consider consolidating duplicate or very similar citations (for example, multiple links to the same repository or docs page) to reduce redundancy and improve clarity.
- Standardize the formatting of the footnote definitions (indentation, line breaks, and spacing) so the Markdown remains clean and readable in the source.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- Please ensure all footnote reference numbers are sequential and each [^n] tag has a single matching definition to avoid out-of-order or missing citations.
- Consider consolidating duplicate or very similar citations (for example, multiple links to the same repository or docs page) to reduce redundancy and improve clarity.
- Standardize the formatting of the footnote definitions (indentation, line breaks, and spacing) so the Markdown remains clean and readable in the source.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
🔭 Outside diff range comments (2)
docs/behavioural-testing-in-rust-with-cucumber.md (2)
1106-1111: Remove the duplicated fragment of footnote 14.Lines 1110-1111 repeat the tail of footnote 14, breaking Markdown rendering and markdown-lint rules (MD053/MD032). Delete the orphaned two-line fragment.
[^14]: *Cucumber-rs* — fully-native Cucumber testing framework for Rust with no external test runners or dependencies. GitHub, accessed on 14 July 2025, <https://github.com/AidaPaul/cucumber-rust> - - runners or dependencies. - GitHub, accessed on 14 July 2025, - <https://github.com/cucumber-rs/cucumber>
90-97: Add the missing footnotes 15, 17 and 19.The body cites
[^15],[^17]and[^19]but the reference list omits them, triggering broken-link warnings (markdown-lint MD051) and leaving readers without sources. Append properly numbered entries at the end of the Works cited section.Example stub:
[^15]: <title> — <author>, accessed on 14 July 2025, <URL> [^17]: <title> — <author>, accessed on 14 July 2025, <URL> [^19]: <title> — <author>, accessed on 14 July 2025, <URL>Also applies to: 110-113
📜 Review details
Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro
📒 Files selected for processing (1)
docs/behavioural-testing-in-rust-with-cucumber.md(13 hunks)
🧰 Additional context used
📓 Path-based instructions (2)
docs/**/*.md
Instructions used from:
Sources:
📄 CodeRabbit Inference Engine
- AGENTS.md
**/*.md
Instructions used from:
Sources:
📄 CodeRabbit Inference Engine
- AGENTS.md
⚙️ CodeRabbit Configuration File
🪛 LanguageTool
docs/behavioural-testing-in-rust-with-cucumber.md
[style] ~667-~667: Consider a different adjective to strengthen your wording.
Context: ... before the When action occurs. For a deeper look at using wiremock in testing, se...
(DEEP_PROFOUND)
[uncategorized] ~1087-~1087: The adjective “Behavior-Driven” is spelled with a hyphen.
Context: ...io/docs/gherkin/reference/> [^8]: BDD (Behavior Driven Development) — ROBOT FRAMEWORK, accesse...
(DRIVEN_HYPHEN)
[typographical] ~1090-~1090: To join two clauses or introduce examples, consider using an em dash.
Context: ...tcase_styles/bdd> [^9]: Given-When-Then - Wikipedia, accessed on 14 July 2025, ...
(DASH_RULE)
[typographical] ~1113-~1113: To join two clauses or introduce examples, consider using an em dash.
Context: ...m/cucumber-rs/cucumber> [^16]: cucumber - Rust - Docs.rs, access...
(DASH_RULE)
[typographical] ~1113-~1113: To join two clauses or introduce examples, consider using an em dash.
Context: ...ber-rs/cucumber> [^16]: cucumber - Rust - Docs.rs, accessed on 1...
(DASH_RULE)
[typographical] ~1135-~1135: To join two clauses or introduce examples, consider using an em dash.
Context: ...the-common-pitfalls> [^23]: Data tables - Cucumber Rust Book, accessed on 14 July ...
(DASH_RULE)
[typographical] ~1160-~1160: To join two clauses or introduce examples, consider using an em dash.
Context: ...ucumber Testing and How to Overcome Them - Medium, accessed on July 14, 2025, ...
(DASH_RULE)
[typographical] ~1164-~1164: To join two clauses or introduce examples, consider using an em dash.
Context: ...95fffb43c8> [^31]: Cucumber in cucumber - Rust - Docs.rs, access...
(DASH_RULE)
[typographical] ~1164-~1164: To join two clauses or introduce examples, consider using an em dash.
Context: ...3c8> [^31]: Cucumber in cucumber - Rust - Docs.rs, accessed on ...
(DASH_RULE)
[typographical] ~1168-~1168: To join two clauses or introduce examples, consider using an em dash.
Context: ...ml> [^32]: CLI (command-line interface) - Cucumber Rust Book, accessed on 14 J...
(DASH_RULE)
[typographical] ~1171-~1171: To join two clauses or introduce examples, consider using an em dash.
Context: ...cli.html> [^33]: Continuous Integration - Cucumber, accessed on 14 July 2025, ...
(DASH_RULE)
|
|
||
| [^8]: BDD (Behavior Driven Development) — ROBOT FRAMEWORK, accessed on 14 July | ||
| 2025, <https://docs.robotframework.org/docs/testcase_styles/bdd> | ||
|
|
There was a problem hiding this comment.
🧹 Nitpick (assertive)
Use en-GB spelling in changed citation titles.
Footnote 8 spells “Behavior Driven Development”; project guidelines mandate en-GB (“Behaviour-Driven Development”) unless the exact title must be preserved. Either quote the original title verbatim in quotation marks or adapt the spelling to comply.
-[^8]: BDD (Behavior Driven Development) — ROBOT FRAMEWORK, accessed on 14 July
+[^\*]: "BDD (Behavior Driven Development)" — ROBOT FRAMEWORK, accessed on 14 JulyCommittable suggestion skipped: line range outside the PR's diff.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~1087-~1087: The adjective “Behavior-Driven” is spelled with a hyphen.
Context: ...io/docs/gherkin/reference/> [^8]: BDD (Behavior Driven Development) — ROBOT FRAMEWORK, accesse...
(DRIVEN_HYPHEN)
🤖 Prompt for AI Agents
In docs/behavioural-testing-in-rust-with-cucumber.md around lines 1086 to 1089,
the footnote 8 citation uses the American English spelling "Behavior Driven
Development." To comply with project guidelines requiring en-GB spelling, either
put the original title in quotation marks to indicate it is verbatim or change
the spelling to "Behaviour-Driven Development" if not quoting exactly. Update
the footnote accordingly.
| Specific Language (DSL) called Gherkin.[^4][^5] Other tools, such as Robot | ||
| Framework, also adopt this style.[^8] Gherkin provides a simple, structured | ||
| grammar for writing executable specifications in plain text files with a | ||
| `.feature` extension.[^6] Its syntax is designed to be intuitive and |
There was a problem hiding this comment.
🧹 Nitpick (assertive)
Insert a comma between consecutive citations.
Gherkin.[^4][^5] renders as one superscript; splice a comma or space to separate multiple footnotes.
-Specific Language (DSL) called Gherkin.[^4][^5]
+Specific Language (DSL) called Gherkin.[^4], [^5]📝 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.
| Specific Language (DSL) called Gherkin.[^4][^5] Other tools, such as Robot | |
| Framework, also adopt this style.[^8] Gherkin provides a simple, structured | |
| grammar for writing executable specifications in plain text files with a | |
| `.feature` extension.[^6] Its syntax is designed to be intuitive and | |
| Specific Language (DSL) called Gherkin.[^4], [^5] Other tools, such as Robot | |
| Framework, also adopt this style.[^8] Gherkin provides a simple, structured | |
| grammar for writing executable specifications in plain text files with a | |
| `.feature` extension.[^6] Its syntax is designed to be intuitive and |
🤖 Prompt for AI Agents
In docs/behavioural-testing-in-rust-with-cucumber.md around lines 39 to 42, the
consecutive citations like [^4][^5] are rendered as a single superscript. Insert
a comma or space between these footnote references to ensure they appear as
separate citations in the rendered document.
Summary
Testing
make fmtmake lintmake testmake markdownlintmake nixiehttps://chatgpt.com/codex/tasks/task_e_687b7c62fba883229d7926ce4eaa32cc
Summary by Sourcery
Restore and augment footnote citations throughout the behavioural testing guide to ensure all referenced tools and articles are properly cited.
Documentation: