racket / racket/scribble

@racket[chunk] and @racket[CHUNK] do not link to scribble's doc

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

#lang scribble/manual

@(require (for-label scribble/lp scribble/lp2 scribble/private/lp))
See also @racket[chunk] and @racket[CHUNK] from @racketmodname[scribble/lp2].

When running the file above through raco setup, it gives the following warning, and the identifiers are not hyperlinked to their documentation (they are underlined in red instead).

.raco-wrapped: WARNING: undefined tag in <pkgs>/foo/scribblings/foo.scrbl:
.raco-wrapped:  ((lib "scribble/private/lp.rkt") CHUNK)
.raco-wrapped:  ((lib "scribble/private/lp.rkt") chunk)

I suspect this has to do with the use in scribble-doc/scribblings/scribble/lp.scrbl of one of these constructs:

  • @title[#:tag "lp" …]{Literate Programming}
  • @defmodulelang[scribble/lp2 #:use-sources (scribble/lp)]{…}

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 with the reproducible scribble/manual example and run it through raco setup to observe the undefined-tag warnings. Then inspect scribble-doc/scribblings/scribble/lp.scrbl, especially the @title and @defmodulelang constructs; done means @racket[chunk] and @racket[CHUNK] link to the scribble/lp2 documentation without warnings.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.