racket / racket/scribble

scribble/comment-reader and quasiquote

Open
#210 0 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

The scribble/comment-reader causes quasiquote (#\u60) to be replaced by a left single quotation mark (#\u2018), which is inconsistent with what other comment forms produce. For example, the first two produce the right thing, but the last doesn't:

#lang scribble/manual
@(require scribble/examples)

@racketblock[(code:comment "`hi")]
@examples[(code:comment "`hi")]
@#reader scribble/comment-reader
(racketblock
;; `hi
)

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 Scribble example using scribble/comment-reader and compare its rendering of quasiquote with the code:comment and examples forms. Trace the comment-reader entry point to find where the character is transformed, then verify that all three examples produce the same quasiquote output.

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
Clearly specified
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.