facebookresearch / facebookresearch/fairscale
[docs] Fix overlap between "Source" link and Return value of the doc string
Open
bug
- Dominant language
- Python
- Stars
- 3.4k
- Forks
- 293
- PR merge metrics
- No merged PRs in 30d
Description
## 🐛 Bug

The hyperlink and doc string overlap and one is unable to figure out the return value.
Contributor guide
Research direction
Start by locating the documentation page and rendered doc string shown in the attached screenshot, then inspect how the “Source” link and Return value are laid out. Done means the hyperlink no longer overlaps the return-value text and the return value is readable in the rendered documentation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100