racket / racket/scribble

code:hilite and indentation correction depends on paren shape?

Open
#230 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

In the following example, why does the second form typeset differently than the first? Could we change the second to match the first, or would this be a breaking change?

#lang scribble/manual

@(racketblock
  ; indentation correction works as desired:
  (foo bar
       (code:hilite [define baz
                     (get-baz bar)])
       baz)
  ; indentation correction does not work:
  (foo bar
       (code:hilite (define baz
                      (get-baz bar)))
       baz))

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 provided #lang scribble/manual example and compare the two racketblock forms using code:hilite. Trace how the bracketed and parenthesized forms apply indentation correction, then determine whether making their output match would change existing behavior; done means the behavior is explained and the compatibility impact is documented.

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.