Lightning-AI / Lightning-AI/pytorch-lightning
Class name displayed incorrectly
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 31.4k
- Forks
- 3.8k
- Avg merge
- 6d 7h
- Merged PRs (30d)
- 6
Description
### 📚 Documentation
### 📚 The doc issue
Hello everyone,
I found what initially looked like a typo in the docs. But it seems like a problem with displaying the text, because it show up correctly when copy-pasting the text. The problem showed up in the two browsers (Edge and Firefox) that I tested.
It looks like the text says "class ightning.pytorch.accelerators" (missing the l in lightning).
I found it on several sites.
Pages like [CUDAAccelerator](https://lightning.ai/docs/pytorch/stable/api/lightning.pytorch.accelerators.CUDAAccelerator.html#lightning.pytorch.accelerators.CUDAAccelerator) all show the class as "class lightning.pytorch.accelerators"
cc @borda
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by opening the linked CUDAAccelerator documentation page in Edge and Firefox and compare the rendered class name with copied text. Check the other affected documentation pages for the same display issue. Done means the rendered class name consistently includes the leading “l” in “lightning”.
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
- 45/100