8000 docs(python): Add `pl.field` into the api docs by thomasjpfan · Pull Request #24846 · pola-rs/polars · GitHub
[go: up one dir, main page]
Skip to content

docs(python): Add pl.field into the api docs #24846

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.

Sign up for GitHub

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

Jump to bottom
Merged
coastalwhite merged 2 commits into from
Oct 13, 2025
Merged

docs(python): Add pl.field into the api docs #24846

coastalwhite merged 2 commits into from
Oct 13, 2025

Conversation

@thomasjpfan
Copy link
Contributor
@thomasjpfan thomasjpfan commented Oct 12, 2025 •
edited
Loading

Closes #24757

This PR adds pl.field into the API docs and an example of it's usage into the docstring.

@thomasjpfan thomasjpfan changed the title Add pl.field into the api docs docs(python): Add pl.field into the api docs Oct 12, 2025
@github-actions github-actions bot added documentation Improvements or additions to documentation python Related to Python Polars and removed title needs formatting labels Oct 12, 2025
@codecov
Copy link
codecov bot commented Oct 12, 2025 •
edited
Loading

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 81.73%. Comparing base (9d42085) to head (2543150).
⚠️ Report is 2 commits behind head on main.

Additional details and impacted files 
@@            Coverage Diff             @@
##             main   #24846      +/-   ##
==========================================
+ Coverage   81.71%   81.73%   +0.01%     
==========================================
  Files        1700     1700              
  Lines      233283   233283              
  Branches     2996     2996              
==========================================
+ Hits       190624   190668      +44     
+ Misses      41897    41853      -44     
  Partials      762      762

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

@coastalwhite coastalwhite merged commit 1306208 into pola-rs:main Oct 13, 2025
20 checks passed
@coastalwhite
Copy link
Collaborator
coastalwhite commented Oct 13, 2025

Thank you!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@ritchie46 ritchie46 Awaiting requested review from ritchie46 ritchie46 is a code owner

@c-peters c-peters Awaiting requested review from c-peters c-peters is a code owner

@alexander-beedie alexander-beedie Awaiting requested review from alexander-beedie alexander-beedie is a code owner

@MarcoGorelli MarcoGorelli Awaiting requested review from MarcoGorelli MarcoGorelli is a code owner

@reswqa reswqa Awaiting requested review from reswqa reswqa is a code owner

1 more reviewer

@coastalwhite coastalwhite coastalwhite approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

documentation Improvements or additions to documentation python Related to Python Polars

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

pl.field() does not appear in docs

2 participants

@thomasjpfan @coastalwhite
0