Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Add conda install instructions and clarity on where to use GT in README.md #552

Merged
merged 2 commits into from
Dec 3, 2024

Conversation

rich-iannone
Copy link
Member

This PR addresses two recommendations from the pyOpenSci review of Great Tables. The first involves adding conda installation information. This has been added to README.md

Fixes: #528

The second recommendation involves adding clarity on where GT code should be run (i.e., mostly in a notebook environment or in a Quarto doc). The README.md has been changed to address this in two paragraphs.

Fixes: #530

Copy link

codecov bot commented Dec 3, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 89.79%. Comparing base (925fa41) to head (5b320f8).
Report is 3 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #552   +/-   ##
=======================================
  Coverage   89.79%   89.79%           
=======================================
  Files          45       45           
  Lines        5321     5321           
=======================================
  Hits         4778     4778           
  Misses        543      543           

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

Copy link
Collaborator

@machow machow left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This seems like a reasonable compromise between showing a table quickly, and making sure people know they need to use .show() if they're in a console. Down the road, we could always make a dedicated "Displaying tables" page in the guide, etc..

@rich-iannone rich-iannone merged commit 4c24bed into main Dec 3, 2024
13 of 14 checks passed
@rich-iannone rich-iannone deleted the docs-readme-conda-run-in-notebook branch December 3, 2024 22:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants