voxel51/fiftyone

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

Open

#1,170 opened on Aug 10, 2021

View on GitHub
 (2 comments) (0 reactions) (0 assignees)Python (4,021 stars) (400 forks)batch import
bugdocumentationgood first issue

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

Tech stack
csshtml
Domain
documentation
Issue type
bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
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.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
basic CSS knowledgefamiliarity with docs theme structure
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80
Research direction
The issue is about inline code blocks in the documentation having whitespace without a gray background. The fix likely involves adjusting the CSS in the docs theme directory (see https://github.com/voxel51/fiftyone/tree/develop/docs/theme). Look for the styles applied to inline code elements (e.g., `<code>` tags) and ensure background applies to all characters, including whitespace. The example screenshot shows the problem.
[BUG] Inline code block formatting does not apply to whitespace · voxel51/fiftyone#1170 | Good First Issue