patrick-kidger / patrick-kidger/jaxtyping

View full types in VSCode on-hover type hints

Open
#62 6 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

question
Dominant language
Python
Stars
1.9k
Forks
96
PR merge metrics
No merged PRs in 30d

Description

When using jaxtyping, I noticed that, even if a function's argument is typed as e.g. Float[Tensor, "b h"], when hovering over the function in VSCode, its argument is typed only as Tensor. Is there some way to get VSCode to display the full type of the function on hover?

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reproducing the hover behavior in VSCode with a jaxtyping annotation such as Float[Tensor, "b h"], then investigate how Python type annotations are exposed to the editor. Establish whether the full type can be displayed and document the supported path or the limitation as the completion criterion.

Written by the indexing model from the issue text.

Assessment

Tech stack
python, vscode
Domain
developer-experience, tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.