racket / racket/htdp

The documentation of 2htdpimage should have illustrations for each option

Open
#183 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

teachpack
Dominant language
Racket
Stars
112
Forks
73
Avg merge
9h 41m
Merged PRs (30d)
1

Description

Various options like mode?, x-place?, y-place? should have complete illustrations in their own section. With this way, users don't need to:

  • Search the entire documentation to see examples of the option that they want (e.g., mode? is only illustrated in circle but not triangle)
  • Experiment in Racket on their own (e.g., are "center" and "middle" in y-place? the same?)

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 locating the 2htdpimage documentation and reviewing the existing sections for options such as mode?, x-place?, and y-place?. Compare how each option is currently illustrated, then add complete illustrations in each option's own section and verify that the examples clarify distinctions such as “center” and “middle”.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
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.