ndmitchell / ndmitchell/hoogle

How to use settings.txt?

Open
#412 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

question
Dominant language
Haskell
Stars
803
Forks
152
PR merge metrics
No merged PRs in 30d

Description

I'm running a local instance of Hoogle (via Nix) with my employer's packages and their dependencies. I've always noticed that hoogle.haskell.org has a more logical order for packages when there are multiple hits (ie preferring base). After some searching, I found that this is probably because of a difference in ReorderModule rules. I also see there exists a misc/settings.txt, but I don't know how to supply this file myself or why the default rules result in a different order compared to hoogle.haskell.org.

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 misc/settings.txt and the ReorderModule rules, then compare how a local Nix instance and hoogle.haskell.org load settings and order multiple matches. Document how users supply a settings file and why the default rules produce different ordering; done means the instructions explain the observed difference clearly.

Written by the indexing model from the issue text.

Assessment

Tech stack
haskell
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.