docs(expr-ir): Add API Reference - #3777
Merged
Merged
Conversation
Towards #3497
Stealing some idea from polars
There's quite a few things I could add quickly
there's a few easy wins there
impressive that I forgot `head` & `tail` only on eager
> `handler`: the name of the handler to use to collect and render this object. By default, it will use the value defined in the Global options's `default_handler` key, or `"python"`. https://mkdocstrings.github.io/usage/#autodoc-syntax
This linking stuff is cool
waaaay easier to see what common things are used
will need to reel in back in on a second pass
dangotbanned
added
documentation
This was referenced Jul 11, 2026
dangotbanned
changed the title
dangotbanned
marked this pull request as ready for review
July 27, 2026 09:30
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Briefly mentioned in (#3773 (comment)) - this PR is the first in a stack that aims to fill out the docs.
Like (#2572), these are additions to and not replacements of the existing docs.
Where possible, I'm trying to avoid changes to existing files - but some cases are unavoidable (e.g. config files)
TL;DR: This approach is easier to avoid merge conflicts, but comes at the cost of large positive diffs
Related issues
ExprIR #2572ExprIR#3497