racket / racket/scribble

examples does not treat escaping properly

Open
#307 3 comments 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

Minimal failing example:

#lang racket
(require scribble/example)

(define ev (make-base-eval))

(define mods '(racket/string racket/list))

#;(examples #:eval ev
          #,`(require ,@mods))
;; fails with
;; examples: exception raised in example
;;  error: "unsyntax: illegal outside of quasisyntax"

(examples #:eval ev #:escape WOO
          (WOO `(require ,@mods)))
;; fails with
;; examples: exception raised in example
;;  error: "WOO: undefined;\n cannot reference an identifier before its definition"

(examples #:eval ev (first '(a b c)))

... if I'm reading the docs correctly.

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 running the minimal examples in the issue and reading the linked scribble/eval documentation for examples and #:escape. Trace the scribble/example implementation that processes escaped and quasiquoted forms. Done means both escaping examples behave as documented while the final basic example continues to work.

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.