lspitzner / lspitzner/pqueue

Please expose .Internals

Open
#18 8 comments 3 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Haskell
Stars
17
Forks
12
PR merge metrics
No merged PRs in 30d

Description

It would be great to have access to some unsafe or just convenient internals. To give two simple examples of each:

* I may want to use `insert'` instead of the Ord instance to provide Ord-free API to the user for a function I'm internally using pqueue in.
* I may have external knowledge about element I'm inserting. For example I may know that new element is maximal for a given MinQueue. Currently `insert` will perform `n` comparisons on the key. With .Internals I could write `unsafeSnoc` that does not do the comparisons along the way, saving time.

Many popular Haskell packages already expose this module. Some choose to not expose it in Haddock documentation (I'd recommend against that). It'd be great if `pqueue` could as well with the usual disclaimers about no guarantees to the contents.

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 by locating the pqueue source definitions for insert, insert', and MinQueue, then review how the package exposes modules and Haddock documentation. Done means an Internals module provides the requested convenience or unsafe operations with the stated lack-of-guarantees disclaimer and corresponding documentation.

Written by the indexing model from the issue text.

Assessment

Tech stack
haskell
Domain
tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.