docs: use latest quartodoc to make description lists #427
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #427 +/- ##
=======================================
Coverage 86.37% 86.37%
=======================================
Files 42 42
Lines 4683 4683
=======================================
Hits 4045 4045
Misses 638 638 ☔ View full report in Codecov by Sentry. |
|
I think this can be merged as is! Thank you for making this possible. |
|
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! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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
Narrow display
@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).