ndmitchell / ndmitchell/hoogle
more detailed information from the JSON API
Nobody has claimed this yet.
- Dominant language
- Haskell
- Stars
- 803
- Forks
- 152
- PR merge metrics
- No merged PRs in 30d
Description
While making a custom template for a more Dash-like web UI for Hoogle I noticed the data provided by the JSON API is fairly aggregated. Most notably the name of things (e.g. fold, hoogle, ...) and the kind of things (function, package, ...) are not available separately but mixed together into 'self'
It would be nice if all the data were available before aggregation (I'm assuming name and e.g. 'package' are actually stored separately.) While it's not terribly difficult to reverse engineer the name and the kind from the single field it seems somewhat wrong, an API should provide data in a form that does not require parsing and guessing on caller side IMO.
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 by tracing how Hoogle's JSON API assembles its response, focusing on the aggregated "self" field and the underlying search-result data. Done means the API exposes names and kinds such as function or package separately, without requiring callers to parse or guess from "self".
Written by the indexing model from the issue text.
Assessment
- Tech stack
- haskell
- Domain
- api
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100