racket / racket/scribble

@examples with #:no-prompt doesn't seem to respect code:blank

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

Nobody has claimed this yet.

Dominant language
Racket
Stars
250
Forks
102
Avg merge
11d 11h
Merged PRs (30d)
1

Description

Example:

#lang scribble/base

@(require scribble/example)

@examples[#:no-prompt
(define x 3)
code:blank
x]

I expected the HTML output for this to contain a blank line between (define x 3) and x. Removing #:no-prompt restores the expected behavior. Using #:lang also works.

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.

Research direction

Start by reproducing the issue with the Scribble example in the report, comparing HTML output with and without #:no-prompt and with #:lang. Trace how @examples handles code:blank in the #:no-prompt case; done means the generated HTML preserves the blank line between the definition and x.

Written by the indexing model from the issue text.

Assessment

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.