Search bindings by kind?
Nobody has claimed this yet.
- Dominant language
- Racket
- Stars
- 250
- Forks
- 102
- Avg merge
- 11d 11h
- Merged PRs (30d)
- 1
Description
When using Scribble's def forms, a #:kind argument is sometimes provided to document the binding as "procedure", "syntax", "class", "constructor", etc. I'd like to be able to filter by kind in a Scribble search, for example to find all documented "syntax class" bindings in the package catalog. Based on the help text of the Scribble search page, I believe this isn't implemented.
I'm not too familiar with Scribble's internals, but I think this would involve extending index-element and scribble/manual-struct. I'm not sure how to do that in a backwards-compatible way. Bonus points if Scribble could output the kind of every binding in search results.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the Scribble search-page help text, then inspect index-element and scribble/manual-struct, the entry points named in the issue. Work out a backward-compatible representation for #:kind filtering and define how search results could show each binding's kind. Done means documented bindings can be filtered by kind in Scribble search, with the optional result detail addressed.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation, search
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100