racket/scribble

Change scribble/blueboxes to scribble/signature-box

Open

#206 opened on Aug 11, 2019

View on GitHub
 (4 comments) (2 reactions) (0 assignees)Racket (102 forks)github user discovery
good first issue

Repository metrics

Stars
 (250 stars)
PR merge metrics
 (Avg merge 12h 51m) (1 merged PR in 30d)

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

Research direction
Create a new library scribble/signature box with the same functionality as scribble/blueboxes but with renamed identifiers. Then update documentation to deprecate scribble/blueboxes.
Tech stack
None
Domain
documentation
Issue type
Refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
RacketGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75