Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

Component doc strings do not show in VSCODE

Open
#82 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
40/100
Issue type
Bug
Clarity
Mostly clear
Activity status
Stale
Tech stack
python, vscode

Research direction

Start by tracing the dash-component-boilerplate build process that produces component docstrings, then compare its generated output with the dash-bootstrap-components output shown in the report. Reproduce the issue in VSCode on Windows and confirm that the full component and Dash HTML/core docstrings display correctly when done.

Written by the indexing model from the issue text.

Description

Hi,

I've noticed that the component doc strings are not showing correctly in VSCODE (on windows). This is also the case with the docstrings in the Dash html and core components libraties. All
you see is a one line header, eg:

html

The docstrings in the dash-bootstrap-components do show correctly:

dbc

The problem must be part of the dash-component-boilerplate build process but I've not
been able to spot it.

Dominant language
Python
Stars
294
Forks
196
PR merge metrics
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from plotly/dash-component-boilerplate

All issues in plotly/dash-component-boilerplate

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.