voxel51/fiftyone

[BUG] Inline code block formatting does not apply to whitespace

Open

#1,170 opened on Aug 10, 2021

View on GitHubContributor guide
 (2 comments) (0 reactions) (0 assignees)Python (400 forks)batch import
bugdocumentationgood first issue

Repository metrics

Stars
 (4,021 stars)
PR merge metrics
 (PR metrics pending)

Description

In the docs, inline codeblocks containing whitespace look distracting in the rendered docs because the whitespace is not given the gray background.

This should be fixable via an appropriate tweak to the docs theme.

Example from the docs:

Contributor guide

Research direction
Check the theme CSS files for inline code styling and ensure whitespace within inline code is also highlighted with background.
Tech stack
css
Domain
documentation
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
CSS
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85