racket / racket/scribble

Change scribble/blueboxes to scribble/signature-box

Open
#206 4 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

In racket/drracket#291 and racket/drracket#172, it was decided that "signature box" is a much better term than "blue box", and various parts of drracket's documentation were updated to use this phrase. Scribble's scribble/blueboxes library uses the term "blue box" in its documentation and the names of its exported identifiers.

We should add a scribble/signature-box library that's the same as scribble/blueboxes but with changed names. Then we should deprecate the scribble/blueboxes library and point users to the new library.

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 reading the scribble/blueboxes library and its documentation at docs.racket-lang.org/scribble/blueboxes.html, cataloging the exported identifiers and terminology that need new names. Done means an equivalent scribble/signature-box library exists and scribble/blueboxes is deprecated with users directed to the new library.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Refactor
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.