facebookresearch / facebookresearch/fairscale

[docs] Fix overlap between "Source" link and Return value of the doc string

Open
#738 1 comment 0 reactions 0 assignees View on GitHub
bug
Dominant language
Python
Stars
3.4k
Forks
293
PR merge metrics
No merged PRs in 30d

Description

## 🐛 Bug

![Screen Shot 2021-07-08 at 9 56 52 PM](https://user-images.githubusercontent.com/32556631/125084556-88c44f80-e07e-11eb-81cf-4d09751147d2.png)

The hyperlink and doc string overlap and one is unable to figure out the return value.

Contributor guide

Open the contributing 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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.