Skip to content

Feat linebreaks in tables - #419

Merged
machow merged 5 commits into
mainfrom
feat-linebreaks-in-tables
Dec 8, 2025
Merged

machow merged 5 commits into
mainfrom
feat-linebreaks-in-tables

Conversation

@machow

@machow machow commented Dec 6, 2025

Copy link
Copy Markdown
Owner

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

codecov-commenter commented Dec 6, 2025 •

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 89.58%. Comparing base (1fc3fbd) to head (f8489e8).
⚠️ Report is 1 commits behind head on main.

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.

@machow
machow marked this pull request as ready for review December 8, 2025 21:38
@machow
machow merged commit fc9f3cc into main Dec 8, 2025
6 checks passed
@github-project-automation github-project-automation Bot moved this to Done in quartodoc Dec 8, 2025

This branch was successfully deployed

1 active deployment
pr-419 — f8489e86 Deployed Dec 6, 2025 by github-actions[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

2 participants