racket / racket/scribble

Should `output` and `outputable/c` also accept a generic interface?

Open
#338 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 scribble/text the output function can deal with most/many common datatypes, and I believe that it would be useful if there was a gen:outputable interface that custom structs could conform to so that the user (or rather, me) doesn't have as much boilerplate to write when I want to output my own structure types over and over again.

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/text implementation of output and the outputable/c entry point to understand how existing datatypes are handled. Define the generic gen:outputable interface and confirm that custom structs can use it with both output paths, with tests covering the intended dispatch and resulting output.

Written by the indexing model from the issue text.

Assessment

Domain
developer-experience
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.