Skip to content

Formatting inconsistency in renderer example output with nested message blocks #122

@superdamaodi

Description

@superdamaodi

Problem

The conversation renderer example output shows a formatting inconsistency when nested message blocks are rendered alongside header tokens. In the README examples, the spacing and block structure do not match between similar cases, which makes the example output harder to follow. This is a small documentation-facing issue, but it affects documentation parity and can confuse readers comparing issue #3 and issue #5.

This matters for users following the README examples because they may assume the renderer treats these cases differently, even though the inconsistency appears to be only in the documented presentation.

Expected Behavior

The example output should format nested message blocks consistently, with header tokens presented in the same style across matching examples. The documentation should preserve a single, predictable layout so readers can compare outputs without ambiguity.

Steps to Reproduce

  1. Open the README renderer examples that include nested message blocks.
  2. Compare the example output for the similar cases referenced in issue Update README.md #3 and issue syntax error in conversation message formatting at Python Example of README #5.
  3. Notice that the formatting around the header tokens is not consistent between the examples.

Suggested Fix

  • Align the example output formatting for the affected renderer examples.
  • Keep header tokens displayed consistently across the related snippets.
  • Verify the updated wording preserves documentation parity with the surrounding examples.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions