Document code span wrapping improvements and frontmatter docs

[leynos]

Summary

• Documented the improved wrapping behavior for inline code spans, allowing wrapping between space-separated spans and clarifying punctuation handling.
• Updated YAML frontmatter handling documentation to reflect preservation during formatting.
• Adjusted several docs style and examples to align with current formatting rules.
• Added a new unit test to verify wrapping between space-separated inline code spans (src/wrap/tests.rs).

Changes

Documentation updates

• CHANGELOG.md: Added entry noting that wrapping is allowed between space-separated inline code spans (Groups of code spans being treated as a single span for wrapping purposes #252).
• docs/architecture.md: Updated diagrams and added note that wrapping may occur between code spans; fixed fence syntax.
• docs/documentation-style-guide.md: Corrected code block fences for readability and consistency.
• docs/execplans/yaml-frontmatter.md: Clarified frontmatter preservation, output stability, and risk notes; updated wording on CLI usage and formatting behavior.
• docs/rust-doctest-dry-guide.md: Tidied prose around doctest code blocks and inline formatting.
• docs/rust-testing-with-rstest-fixtures.md: Aligned table formatting in header rows for readability.

Tests

• src/wrap/tests.rs: Added test wrap_text_breaks_between_space_separated_code_spans to verify wrapping between space-separated code spans.

Other

• Minor wording tweaks to ensure frontmatter grouping is narrow and only affects requested wrap opportunities.

Validation plan

• Build and verify documentation builds cleanly (no broken code blocks or syntax issues).
• Run repository linters for docs (markdownlint, style checks) as part of CI.

Notes

• This change is documentation-only; no runtime behavior changes.
• Feeds into the docs to reflect the new wrapping behavior and frontmatter handling described in the changelog and architecture notes.

◳ Generated by DevBoxer ◰

---

ℹ️ Tag @devboxerhub to ask questions and address PR feedback

📎 Task: https://www.devboxer.com/task/87009be1-c153-4fa1-866d-a004768bf44f

📝 Closes #252

Summary by Sourcery

Update documentation to reflect refined inline code-span wrapping behavior and YAML frontmatter preservation while aligning existing docs and examples with current formatting rules.

Documentation:

• Document that wrapping is allowed between space-separated inline code spans while keeping trailing punctuation attached to the preceding span.
• Clarify YAML frontmatter handling and risks in exec plan docs, emphasizing byte-for-byte preservation alongside normal body formatting.
• Fix and standardize Markdown fences, tables, and prose wrapping across architecture, style guide, doctest, and rstest fixture documentation.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro

Run ID: a6e0f59a-406f-4791-92f9-3718cee0bbf6

📥 Commits

Reviewing files that changed from the base of the PR and between 1dc00fd and 9c906f6.

📒 Files selected for processing (1)

• src/wrap/tests.rs

---

Documentation updates for inline code span wrapping and YAML frontmatter

This pull request updates documentation to describe improved inline code-span wrapping behaviour and clarifies YAML frontmatter preservation. The changes are documentation-only and add a regression test; they do not modify the formatter’s runtime behaviour.

New document

• docs/execplans/yaml-frontmatter.md — New execution plan describing frontmatter preservation during formatting, output-stability guarantees, CLI/formatting wording, and a reformatted Risks section (Severity, Likelihood, Mitigation shown as nested sub-bullets for readability).

Documentation updates

• CHANGELOG.md — Added an Unreleased "Fixed" entry stating that wrapping is permitted between space-separated inline code spans (refs issue #252).
• docs/architecture.md — Expanded the inline-code punctuation-wrapping rule, clarified that punctuation is only grouped when it immediately follows a code span, documented that whitespace between separate inline code spans is a legitimate wrap opportunity, and corrected diagrams/fence syntax.
• docs/documentation-style-guide.md — Fixed code block fence syntax for consistency and readability.
• docs/rust-doctest-dry-guide.md and docs/rust-testing-with-rstest-fixtures.md — Prose and table formatting adjustments.
• Minor wording tweaks elsewhere to limit the scope of frontmatter grouping impact.

Tests

• src/wrap/tests.rs — Adds wrap_text_breaks_between_space_separated_code_spans, a regression-style unit test asserting the wrapper may break between space-separated inline code spans and that no output line exceeds the requested width. The test stabilises input formatting by using concatenation for the regression input.

Implementation status and relation to issue #252

• This PR is documentation-focused and adds a regression test derived from issue #252’s example.
• Earlier automated analysis flagged that the original PR contained only documentation and no runtime fixes. A later inspection observed that the regression test enforces the intended behaviour and that the existing wrapping logic in inline.rs already produces the desired breaks; therefore no runtime code changes were required in this PR. The test locks the expected behaviour in CI.
• If future investigation shows the behaviour regresses, targeted runtime fixes should follow the diagnostic and repair steps outlined in the earlier automated assessment (tokenisation/span coupling adjustments in wrap/inline.rs and related tests).

Validation

• Validation plan: build the docs and run markdown linters/style checks in CI to ensure formatting and rendering are correct.

Walkthrough

Fix wrapping behaviour so consecutive space-separated inline code spans can break between spans; clarify in architecture docs that punctuation only groups when immediately following an inline code span; reformat three risk entries in YAML frontmatter docs; add a unit test validating wrap behaviour for spaced code spans.

Changes

Cohort / File(s)	Summary
Changelog & docs CHANGELOG.md, docs/architecture.md	Add a "Fixed" changelog entry referencing issue #252. Expand architecture description to state punctuation groups only when immediately following an inline code span and explicitly allow breaks between space-separated code spans.
Documentation formatting docs/execplans/yaml-frontmatter.md	Reformat three ## Risks entries from inline Severity: ... Likelihood: ... Mitigation: ... lines into nested bullet lists with proper line breaks and indentation.
Tests src/wrap/tests.rs	Add a unit test asserting wrap_text permits line breaks between backticked, space-separated code spans and enforces a maximum display width of 80 columns.

Poem

Space-separated spans no longer cling,
Break where the gentle spaces sing,
Punctuation bonds only when near,
Lines unfurl and breathe, sincere. ✨

🚥 Pre-merge checks | ✅ 5 | ❌ 4

❌ Failed checks (3 warnings, 1 inconclusive)

Check name	Status	Explanation	Resolution
Testing	⚠️ Warning	The PR adds only a unit test for code span wrapping, validating width constraints at a single breakpoint. However, the custom check requires snapshot tests for text-based output changes and property-based testing across input bounds.	Create integration tests with reference input/output files in tests/data/ and add property-based testing using proptest across column widths 40–120. Introduce snapshot tests using insta for multi-line output validation.
User-Facing Documentation	⚠️ Warning	The custom check requires user-facing functionality documented in docs/users-guide.md, which does not exist. The README.md fails to document the new inline code span wrapping behaviour introduced by this PR (issue #252).	Update README.md to document the new wrapping behaviour for inline code spans, or create docs/users-guide.md and update the check reference accordingly.
Developer Documentation	⚠️ Warning	PR documents inline code punctuation wrapping improvement in CHANGELOG.md and docs/architecture.md with regression test in src/wrap/tests.rs, but fails to document the architectural change in docs/developers-guide.md as required.	Add section to docs/developers-guide.md documenting inline code punctuation handling architecture, explaining trailing punctuation coupling and whitespace wrapping rules, referencing issue #252 for design context.
Module-Level Documentation	❓ Inconclusive	Cannot verify module-level and public function documentation standards as the modified src/wrap/tests.rs file is inaccessible.	Provide the complete content of src/wrap/tests.rs to verify whether the module carries appropriate docstrings and the new test function meets documentation requirements.

✅ Passed checks (5 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title accurately describes the primary changes: documenting code span wrapping improvements and YAML frontmatter documentation updates.
Description check	✅ Passed	The description comprehensively relates to the changeset, covering documentation updates, test additions, and validation plans aligned with the changes.
Linked Issues check	✅ Passed	The PR addresses issue #252 by documenting the refined wrapping behaviour and adding a regression test verifying that wrapping occurs between space-separated code spans, satisfying the primary objective.
Out of Scope Changes check	✅ Passed	All changes remain within scope: documentation updates, CHANGELOG entry, architectural notes, and a regression test directly supporting the inline code-span wrapping improvements and frontmatter preservation.
Docstring Coverage	✅ Passed	Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

📝 Generate docstrings

• Create stacked PR
• Commit on current branch

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch fix-inline-code-span-wrapping-g4jg6o

---

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[sourcery-ai]

Reviewer's Guide

This PR refreshes documentation to describe the new inline code span wrapping behavior and YAML frontmatter preservation, while also fixing code fence syntax, table alignment, and prose for consistency with current formatter behavior.

Sequence diagram for formatting Markdown with YAML frontmatter

sequenceDiagram
    actor User
    participant CLI as CLI_main
    participant Splitter as FrontmatterSplitter
    participant Proc as ProcessModule
    participant Renumber as RenumberLists
    participant Breaks as FormatBreaks
    participant Out as Output

    User->>CLI: mdtablefix --wrap --breaks --in-place file.md
    CLI->>Splitter: split_frontmatter(input)
    Splitter-->>CLI: prefix, body

    CLI->>Proc: process_stream_opts(body, options)
    Proc-->>CLI: formatted_body

    CLI->>Renumber: renumber_lists(formatted_body)
    Renumber-->>CLI: body_after_renumber

    CLI->>Breaks: format_breaks(body_after_renumber)
    Breaks-->>CLI: body_after_breaks

    CLI->>Out: combine(prefix, body_after_breaks)
    Out-->>User: write formatted file (prefix preserved byte_for_byte)

Loading

File-Level Changes

Change	Details	Files
Clarify YAML frontmatter handling and implementation/risks in the exec plan docs.	Reflow paragraph describing byte-for-byte preservation of the leading YAML block while still formatting the Markdown body under CLI flags like --wrap and --breaks. Condense each risk entry so severity, likelihood, and mitigation appear in a single wrapped paragraph while keeping content unchanged. Reflow observations, decision log, and outcomes sections to improve readability without altering technical detail about the shared frontmatter splitter and its placement in process/main modules. Clarify Stage E docs work and validation notes, including when README and architecture docs are updated and when nixie can be skipped. Tighten validation/rollback guidance and the final revision note while preserving the described behavior and test coverage of the frontmatter splitter.	docs/execplans/yaml-frontmatter.md
Document the refined inline code span wrapping behavior in the architecture docs and changelog.	Fix Mermaid code fence syntax from a four-backtick fence to a standard ```mermaid fence so the diagram renders correctly. Add a short explanation that whitespace between separate inline code spans remains a valid wrap opportunity while trailing punctuation remains attached to the preceding span. Extend the changelog entry to note that wrapping is allowed between space-separated inline code spans and reference issue Groups of code spans being treated as a single span for wrapping purposes #252.	docs/architecture.md CHANGELOG.md
Align documentation examples and style with current Markdown formatting rules.	Normalize rust code fence syntax in the documentation style guide example from ````rust,no_run to rust,no_run and close it with a matching fence. Reflow lines in the Rust doctest DRY guide so sentences about doctest success criteria and assert! macros wrap cleanly without changing meaning. Improve alignment and spacing in rstest comparison tables, widening the header cells and matching alignment in all rows for readability. Minorly reflow a Rust testing reference footnote so the URL sits on the same line as its description for cleaner output.	docs/documentation-style-guide.md docs/rust-doctest-dry-guide.md docs/rust-testing-with-rstest-fixtures.md

Assessment against linked issues

Issue	Objective	Addressed	Explanation
#252	Update the inline code wrapping behavior so that groups of backtick-delimited code spans separated by spaces are not treated as a single unbreakable span, allowing line breaks between spans (e.g., allowing a break after "json," in the provided example).	❌	The PR only updates documentation (CHANGELOG and various docs) to describe the improved wrapping behavior and other topics. There are no code changes affecting the formatter’s wrapping logic, so the underlying bug described in the issue is not implemented or fixed by this PR.

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it. You can also reply to a
  review comment with @sourcery-ai issue to create an issue from it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time. You can also comment
  @sourcery-ai title on the pull request to (re-)generate the title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time exactly where you
  want it. You can also comment @sourcery-ai summary on the pull request to
  (re-)generate the summary at any time.
• Generate reviewer's guide: Comment @sourcery-ai guide on the pull
  request to (re-)generate the reviewer's guide at any time.
• Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
  pull request to resolve all Sourcery comments. Useful if you've already
  addressed all the comments and don't want to see them anymore.
• Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
  request to dismiss all existing Sourcery reviews. Especially useful if you
  want to start fresh with a new review - don't forget to comment
  @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[coderabbitai]

Actionable comments posted: 5

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@CHANGELOG.md`:
- Around line 20-22: Remove the unimplemented change from the "Fixed" section by
deleting the line block that reads "Allow wrapping between space-separated
inline code spans instead of treating the full sequence as a single unbreakable
unit. ([`#252`](https://github.com/leynos/mdtablefix/issues/252))" from
CHANGELOG.md so the release notes only reflect actual code changes; keep the
rest of the changelog intact and save the updated file for the release,
re-adding this entry only when the wrapping implementation (issue `#252`) is
implemented in a separate PR.

In `@docs/architecture.md`:
- Around line 444-449: The paragraph starting "This grouping is deliberately
narrow." in docs/architecture.md asserts a formatter behavior that isn't
implemented; either remove that paragraph entirely or change its language to
future/conditional tense (e.g., "will remain a valid break opportunity" or "is
planned to") and add a brief note that the behavior is pending until the
formatter changes are merged; update the sentences that reference examples like
`.toml`, `.json`, `.json5`, `.yaml`, and `.yml` accordingly so the doc no longer
states the behavior as already implemented.

In `@docs/execplans/yaml-frontmatter.md`:
- Around line 120-125: The two wrapped decision log entries are missing terminal
periods; add a full stop at the end of the "Decision: treat unmatched opening
delimiters as ordinary Markdown instead of partially shielding the document"
entry and also add a full stop to the "Date/Author: 2026-04-05 22:45Z / Droid"
entry so both sentences terminate with punctuation and match the document's
prose style.
- Around line 264-265: Remove the conditional skip path that allows skipping
"make nixie" from the validation steps and ensure "make nixie" remains listed as
a required validator in the document’s final checklist; specifically edit the
section referencing "If `docs/architecture.md` does not change any Mermaid
content, `make nixie` may be skipped." to delete that sentence and update the
final checklist so it unambiguously requires running "make nixie" for `**/*.md`
Mermaid validation.

In `@docs/rust-doctest-dry-guide.md`:
- Line 109: Rewrap the Markdown paragraph containing the text 'specifier for
clarity.[^3] A doctest "passes" when it compiles and runs without' so no line
exceeds 80 characters; split the sentence into multiple lines at natural word
boundaries (e.g., after punctuation or between clauses) while preserving the
exact wording and Markdown punctuation and keeping inline references like [^3]
and quoted text intact.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

• Push a commit to this branch (recommended)
• Create a new PR with the fixes

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro

Run ID: 200fe043-0c87-4b6f-897e-14fc5ba15339

📥 Commits

Reviewing files that changed from the base of the PR and between 9a50bbd and 12322c3.

📒 Files selected for processing (6)

• CHANGELOG.md
• docs/architecture.md
• docs/documentation-style-guide.md
• docs/execplans/yaml-frontmatter.md
• docs/rust-doctest-dry-guide.md
• docs/rust-testing-with-rstest-fixtures.md

[coderabbitai]

♻️ Duplicate comments (1)

CHANGELOG.md (1)

20-22: ⚠️ Potential issue | 🔴 Critical

Remove this unreleased fix claim now.

Delete Line 20-Line 22 from Fixed until the formatter change for issue #252 lands in code. Keep changelog entries tied to implemented runtime behaviour only.

Triage: [type:docstyle]

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed.

In `@CHANGELOG.md` around lines 20 - 22, Remove the unreleased claim from the
"Fixed" changelog: delete the entry that reads "Allow wrapping between
space-separated inline code spans instead of treating the full sequence as a
single unbreakable unit.
([`#252`](https://github.com/leynos/mdtablefix/issues/252))" from the "Fixed"
section so CHANGELOG.md only lists implemented behavior; leave the rest of the
document intact and add the entry back only when the formatter change for issue
`#252` is merged and released.

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Duplicate comments:
In `@CHANGELOG.md`:
- Around line 20-22: Remove the unreleased claim from the "Fixed" changelog:
delete the entry that reads "Allow wrapping between space-separated inline code
spans instead of treating the full sequence as a single unbreakable unit.
([`#252`](https://github.com/leynos/mdtablefix/issues/252))" from the "Fixed"
section so CHANGELOG.md only lists implemented behavior; leave the rest of the
document intact and add the entry back only when the formatter change for issue
`#252` is merged and released.

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro

Run ID: 238dc0a0-da1a-4026-abc8-d60ae3f89df2

📥 Commits

Reviewing files that changed from the base of the PR and between 12322c3 and d8ef636.

📒 Files selected for processing (3)

• CHANGELOG.md
• docs/architecture.md
• docs/execplans/yaml-frontmatter.md

[coderabbitai]

Tip

For best results, initiate chat on the files or code changes.

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
# Check latest commits on the PR branch
gh pr view 272 --repo leynos/mdtablefix --json commits,files | jq '{
  commits: [.commits[] | {oid: .oid, messageHeadline: .messageHeadline}],
  changedFiles: [.files[] | .path]
}'

Length of output: 555

---

🏁 Script executed:

#!/bin/bash
# Show the diff for the regression test commit
git show 1dc00fdf5f4333cf64b3d8c8925bfea9d1d57a79 -- src/wrap/tests.rs

Length of output: 1664

---

🏁 Script executed:

#!/bin/bash
cat src/wrap/inline.rs
echo "=== tokenize/mod.rs ==="
cat src/wrap/tokenize/mod.rs

Length of output: 19856

---

@leynos: Yes — the situation has changed since the previous assessment. The latest commit (1dc00fdf) adds a regression test in src/wrap/tests.rs that covers the exact space-separated code-span sequence from issue #252. The commit message confirms that the wrapping logic was already correct in src/wrap/inline.rs before this PR, so no runtime code change was needed.

Inspecting inline.rs directly confirms this. The should_couple_whitespace function's SpanKind::Code arm only couples whitespace when the following token is entirely trailing punctuation:

(SpanKind::Code, Some(next)) if next.chars().all(is_trailing_punct) => true,

It does not couple whitespace when the following token is another inline code span, so determine_token_span breaks at the whitespace between code spans and treats each one as an independently breakable group — which is precisely the behaviour required by #252.

The regression test locks in that behaviour at the public wrap_text entry point. No further work is required to address #252; the failed check in the earlier assessment reflected the state of the PR before that commit was pushed.

[leynos]

@coderabbitai Have the following now been resolved?

• In docs/execplans/yaml-frontmatter.md, the Risk bullets now inline Severity, Likelihood, and Mitigation on a single wrapped line, which hurts quick scanning compared to the previous per-line structure; consider keeping these as separate labeled lines or sub-bullets under each Risk for readability.

[coderabbitai]

Tip

For best results, initiate chat on the files or code changes.

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
cat docs/execplans/yaml-frontmatter.md

Length of output: 12986

---

@leynos: Yes — this has been resolved. The ## Risks section in docs/execplans/yaml-frontmatter.md now uses indented sub-bullets for each field under every risk entry, e.g.:

- Risk: frontmatter might still be modified by CLI-only transforms …
  - Severity: high
  - Likelihood: medium
  - Mitigation: protect the body split at the highest shared pipeline boundary …

All three risk entries follow this structure, so Severity, Likelihood, and Mitigation are each on their own labelled line and easy to scan at a glance.

[coderabbitai]

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@src/wrap/tests.rs`:
- Around line 275-280: The test uses a backslash-continued string literal for
the paragraph in the variable `input`; replace that with an explicit
concatenation using Rust's concat!() so spacing is explicit and stable (e.g.,
build the long paragraph via concat!("The file loader selects the parser based
on the extension (", ".toml", ... )). Update the `input` Vec entry to use
concat!() to join the pieces into a single String literal and remove the
trailing backslash line continuations.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

• Push a commit to this branch (recommended)
• Create a new PR with the fixes

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro

Run ID: c3f1b0cc-fa85-4b77-8882-b2cba3d474b3

📥 Commits

Reviewing files that changed from the base of the PR and between d8ef636 and 1dc00fd.

📒 Files selected for processing (1)

• src/wrap/tests.rs