Skip to content

typing: update docs to prefer IntoDataFrameT | IntoLazyFrameT#3679

Closed
sriharan0804 wants to merge 3 commits into
narwhals-dev:mainfrom
sriharan0804:docs-intoframet-usage
Closed

typing: update docs to prefer IntoDataFrameT | IntoLazyFrameT#3679
sriharan0804 wants to merge 3 commits into
narwhals-dev:mainfrom
sriharan0804:docs-intoframet-usage

Conversation

@sriharan0804

@sriharan0804 sriharan0804 commented Jun 11, 2026 •
edited
Loading

Copy link
Copy Markdown

Description

This PR updates user-facing documentation and examples to prefer IntoDataFrameT | IntoLazyFrameT over IntoFrameT.

Additionally, the IntoFrameT docstrings have been updated to discourage direct usage and guide users toward the more explicit type annotations.

What type of PR is this? (check all applicable)

  • 📝 Documentation

Related issues

Checklist

  • Code follows style guide (ruff)
  • Tests added
  • Documented the changes

MarcoGorelli
MarcoGorelli reviewed Jun 19, 2026
View reviewed changes
Comment thread docs/basics/complete_example.md Outdated
Comment on lines +26 to +27
```py

```py

@MarcoGorelli MarcoGorelli Jun 19, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

why this change?

@MarcoGorelli

MarcoGorelli commented Jun 19, 2026

Copy link
Copy Markdown
Member

can you address my comment instead of merging main please

@sriharan0804

sriharan0804 commented Jun 19, 2026

Copy link
Copy Markdown
Author

@MarcoGorelli
Thanks for pointing that out.

That indentation change was not intentional and is unrelated to the goal of this PR. I'll revert the formatting-only change and keep the PR focused on updating the IntoFrameT documentation and examples.

@MarcoGorelli

MarcoGorelli commented Jun 20, 2026

Copy link
Copy Markdown
Member

thanks for your pr

i'm a bit tight on time so can't really be bothered to keep leaving "revert unrelated changes" comments - please revert all unrelated changes and ping me when ready. make sure to re-read your pr first, thanks

@sriharan0804 sriharan0804 force-pushed the docs-intoframet-usage branch from ad1cd8b to 7b90d2e Compare June 21, 2026 07:41
@sriharan0804

sriharan0804 commented Jun 21, 2026

Copy link
Copy Markdown
Author

@MarcoGorelli
Thanks for the feedback. I've cleaned up the PR, reverted the unrelated formatting changes, and re-reviewed the diff to keep it focused on the IntoFrameT documentation updates. It should be ready for another look.

MarcoGorelli
MarcoGorelli reviewed Jun 21, 2026
View reviewed changes
Comment thread docs/backcompat.md
Comment on lines -213 to +217
To check if a dtype is a datetime (regardless of `time_unit` or `time_zone`)
To check if a dtype is a datetime (regardless of `time_unit` or `time_zone`)

@MarcoGorelli MarcoGorelli Jun 21, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

there's still unrelated changes - closing for now then

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

Reviewers

@MarcoGorelli MarcoGorelli MarcoGorelli left review comments

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

typing: Don't use IntoFrameT in docs, use IntoDataFrameT | IntoLazyFrameT

2 participants

@sriharan0804 @MarcoGorelli