racket / racket/drracket

‘drracket/tool-lib’ is undocumented

Open
#103 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Racket
Stars
516
Forks
103
PR merge metrics
No merged PRs in 30d

Description

“DrRacket Plugins” mentions both of

  • drracket/tool
  • drracket/tool-lib

but drracket/tool-lib is never used nor described in the rest of the documentation.

I've been requiring it from the DrRacket Interactions to launch a DrRacket while working on a tool. Is there something simple to mention about its behaviour and/or purpose? Is this comment from its implementation correct, and so a safe initial addition to the documentation:

This first time this is loaded, it loads all of DrRacket and invokes
the main unit, starting up DrRacket. After that, it just provides
all of the names in the tools library, for use defining keybindings

Is it then also safe to add:

Tools [will usually?] require drracket/tool.

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 “DrRacket Plugins” documentation and compare its treatment of drracket/tool with the implementation comment for drracket/tool-lib. Confirm the described loading behavior and relationship to tools, then document the accurate purpose and usage of drracket/tool-lib.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.