purescript / purescript/pursuit

Searching for instances

Open
#349 0 comments 8 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Haskell
Stars
174
Forks
47
PR merge metrics
No merged PRs in 30d

Description

Currently instances only appear when searching by name. This is not ideal because instance names are very rarely important; if you want to know about an instance / whether an instance exists, it makes much more sense search for either the class, or one of the types occurring in it. Additionally, having instances appear when searching by name adds quite a lot of noise to the results.

@justinwoo, @joneshf and I discussed on Slack, and came up with a couple of proposals:

  • Remove instances from normal search results, and instead provide some way of opting-in to searching for instances; perhaps with a button or a new search syntax like "instances: Array" or "instances: Foldable" to search for instances that Array has or instances of Foldable.
  • Provide a link under types and classes which takes you straight to the instance search for that type or class, making it easy to find other instances in addition to those defined in the module.

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

No files, tests, or entry points are named. Start by tracing the existing instance search behavior and reviewing the two proposed approaches; done means implementing a decided way to reduce noise in normal results while still making relevant instances discoverable.

Written by the indexing model from the issue text.

Assessment

Tech stack
haskell
Domain
search
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.