Lightning-AI / Lightning-AI/lightning-thunder

[docs] thunder.jit - args are not rendered correctly.

Open
#1,302 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation
Dominant language
Python
Stars
1.5k
Forks
121
PR merge metrics
No merged PRs in 30d

Description

Link - https://lightning-thunder.readthedocs.io/en/latest/reference/generated/thunder.jit.html#thunder.jit

It looks like the rendered document splits the typing information and description.

![image](https://github.com/user-attachments/assets/48edfc71-127a-486c-af40-29c1741ec355)
![image](https://github.com/user-attachments/assets/07b677c8-517e-4d18-b704-66fade0d673a)

cc @borda @lantiga @apaz-cli

Contributor guide

No contributing guide indexed for this repository

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 with the linked thunder.jit API reference and trace the documentation source that generates its rendered argument list. Compare the typing information and descriptions shown in the screenshots, then verify that the generated page keeps each argument's type and description together.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.