docs: add examples to reference pages

posit-dev / great-tables

Make awesome display tables using Python.

https://posit-dev.github.io/great-tables/

MIT License

1.42k stars 48 forks source link

docs: add examples to reference pages #328

Closed jrycw closed 1 month ago

jrycw commented 1 month ago

Fix #322.

This PR aims to enhance our documentation by:

Adding missing examples.
Adding reference links for md() and html() to GT.tab_header().
Adding reference links for loc.body(), style.fill(), style.text(), and style.borders() to GT.tab_style().

It appears that we might encounter a minor issue with GT.save() at this moment, so I'll leave the examples blank for now.

codecov-commenter commented 1 month ago

Codecov Report

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

Project coverage is 83.43%. Comparing base (5ea06af) to head (16dfd9c).

Additional details and impacted files

```diff @@ Coverage Diff @@ ## main #328 +/- ## ======================================= Coverage 83.43% 83.43% ======================================= Files 41 41 Lines 4287 4287 ======================================= Hits 3577 3577 Misses 710 710 ```

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

rich-iannone commented 1 month ago

I'll commit these small changes (mostly just wanted to let the changes be seen, rather than just force pushing into the branch).

rich-iannone commented 1 month ago

@machow assuming these changes are okay, feel free to merge any time.

jrycw commented 1 month ago

Looks great! Thank you! I have a few recommended changes but they are really just small touchups.

@rich-iannone, thanks for the touchups.