posit-dev / great-tables

Make awesome display tables using Python.
https://posit-dev.github.io/great-tables/
MIT License
1.9k stars 71 forks source link

docs: use latest quartodoc to make description lists #427

Closed machow closed 1 month ago

machow commented 2 months ago

This PR uses the main branch of quartodoc to start wiring up an alternative style of listing parameters. This format is meant to fix the issue of the description column being very narrow on mobile.

Expand to see some screenshots

## Basic example | **old** | **new** | | ------ | ------ | | image | image | ## Narrow display | **old** | **new** | | ------- | -------- | | image | image |

@rich-iannone do you mind picking up and making sure it styles to your liking?! We can change anything in quartodoc and are living on the bleeding edge 😄. I noticed just now the display of defaults has a bug (title is a required paramter, but the new style is showing = None).

codecov[bot] commented 2 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 87.86%. Comparing base (06b1408) to head (4f2ae11). Report is 37 commits behind head on main.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #427 +/- ## ======================================= Coverage 87.86% 87.86% ======================================= Files 42 42 Lines 4852 4852 ======================================= Hits 4263 4263 Misses 589 589 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

rich-iannone commented 2 months ago

I think this can be merged as is! Thank you for making this possible.

machow commented 2 months ago

I'm going to try plugging quartodoc description lists into py-shiny this week as a sanity check, so once that's done will circle back, release in quartodoc, and merge here!