Skip to content

Conversation

@machow
Copy link
Owner

@machow machow commented Dec 6, 2025

This PR addresses #407, by allowing linebreaks in tables. This enables parameter descriptions to include markdown lists, etc..

Key details:

  • Currently, linebreaks are turned into spaces, so they don't break the table (github format)
  • Now
    • We use a grid table, which can handle linebreaks
    • When two linebreaks are detected, we do not turn any linebreaks into spaces

For example here, is a table we might generate with linebreaks

  +---------+--------+----------------------------------------+------------+
  | Name    | Type   | Description                            | Default    |
  +=========+========+========================================+============+
  | data    |        | The data parameter with markdown list: | _required_ |
  |         |        |                                        |            |
  |         |        | - First item                           |            |
  |         |        | - Second item                          |            |
  |         |        | - Third item                           |            |
  +---------+--------+----------------------------------------+------------+
  | options | dict   | Configuration options with list:       | _required_ |
  |         |        |                                        |            |
  |         |        | - `option1`: First option              |            |
  |         |        | - `option2`: Second option             |            |
  +---------+--------+----------------------------------------+------------+

@codecov-commenter
Copy link

⚠️ Please install the 'codecov app svg image' to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 89.58%. Comparing base (1fc3fbd) to head (f8489e8).
❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #419      +/-   ##
==========================================
+ Coverage   89.53%   89.58%   +0.04%     
==========================================
  Files          40       40              
  Lines        3183     3198      +15     
==========================================
+ Hits         2850     2865      +15     
  Misses        333      333              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: No status

Development

Successfully merging this pull request may close these issues.

3 participants