Skip to content

Document builtin overloads that jet spaces add at runtime, such as wp.value() on scalar jets #2311

Description

@alecjacobson

Documentation gap

Forward-mode jets (GH-1813) attach overloads to existing builtins when a wp.JetSpace or wp.JetSpace2 is created: wp.value(), and jet versions of wp.sin(), wp.length(), wp.svd3() and so on. The generated API reference lists only the overloads registered at import time, so for example the wp.value() page shows only float16/float32/float64 signatures and looks like an identity function, even though its main use is extracting the value of a scalar jet.

The docstrings now describe the jet arguments in prose (for wp.value(): an instance of J.scalar for a space J, with a doctest). What remains is to make such runtime overloads visible in the generated reference, for example by:

  • listing, on each builtin's page, that jet spaces add overloads for it, with a link to the jets guide; or
  • documenting the jet overloads once, as a table in the jets guide or API reference, rather than per builtin.

This was split out of the jets review to avoid extending the Sphinx builtin-reference machinery in that MR.


This issue was written by Claude Code on behalf of @alecjacobson.

Activity

  1. added
    docsImprovements or additions to documentation
    on Nov 13, 2026
  2. added this to the 1.20.0 milestone on Nov 13, 2026
  3. naitik-ML-AI commented on Nov 13, 2026

    @naitik-ML-AI

    Hi! I'd like to contribute a documentation improvement for this issue. I'm exploring Warp's forward-mode Jet API and would like to help make the runtime-added builtin overloads easier to discover in the generated reference. Would a focused addition to the Jet guide (with a small table of affected builtins and links to their API pages) be the preferred approach? I can prepare a documentation-only PR once the scope and location are confirmed.

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    docsImprovements or additions to documentation

    Projects

    No projects

      Milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions