Skip to content

docs: correct docstring for the fns= parameter in the fmt() method#818

Merged
rich-iannone merged 5 commits into
mainfrom
docs-fmt-docstrings-correct
Feb 13, 2026
Merged

docs: correct docstring for the fns= parameter in the fmt() method#818
rich-iannone merged 5 commits into
mainfrom
docs-fmt-docstrings-correct

Conversation

@rich-iannone
Copy link
Copy Markdown
Member

This pull request makes a small change to the docstrings of the .fmt() method. The change corrects the text relating to the fns= parameter, clarifying that it only accepts a single formatting function (i.e., doesn't accept a list of functions).

This is related to an earlier PR (#327), which will be closed in favor of fixing the misleading documentation here (i.e., not modifying the code to fit the incorrect statement).

@rich-iannone rich-iannone marked this pull request as ready for review February 13, 2026 01:08
@rich-iannone rich-iannone requested a review from machow as a code owner February 13, 2026 01:08
@codecov
Copy link
Copy Markdown

codecov Bot commented Feb 13, 2026

Codecov Report

❌ Patch coverage is 75.00000% with 1 line in your changes missing coverage. Please review.
✅ Project coverage is 92.31%. Comparing base (a418234) to head (279c102).
⚠️ Report is 2 commits behind head on main.

Files with missing lines Patch % Lines
great_tables/_formats.py 75.00% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main     #818      +/-   ##
==========================================
- Coverage   92.32%   92.31%   -0.02%     
==========================================
  Files          49       49              
  Lines        6023     6026       +3     
==========================================
+ Hits         5561     5563       +2     
- Misses        462      463       +1     

☔ 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.

@github-actions github-actions Bot temporarily deployed to pr-818 February 13, 2026 01:17 Destroyed
Copy link
Copy Markdown
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.

LGTM thanks!

@rich-iannone rich-iannone merged commit 9a48651 into main Feb 13, 2026
12 of 14 checks passed
@rich-iannone rich-iannone deleted the docs-fmt-docstrings-correct branch February 13, 2026 17:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants