racket / racket/drracket

documentation for get-definitions-text and get-context of drracket:rep:text<%> ?

Open
#264 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

I found these two public methods useful, but not yet documented.
I used them in my code, but I'm not sure whether it's problematic.
One of my use cases is here: https://github.com/yjqww6/drcomplete/blob/7a829750df8e3966682f43e63c57bfade05b0950/drcomplete-user-defined/tool.rkt#L58

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 public methods get-definitions-text and get-context of drracket:rep:text<%>, then review the use case in drcomplete-user-defined/tool.rkt at line 58. Document what the methods do and whether using them as shown is supported or problematic.

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
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.