haskell / haskell/unix

Revitalise System.Posix.DynamicLinker.Module

Open
#260 1 comment 0 reactions 0 assignees View on GitHub
type: bug type: enhancement
Dominant language
Haskell
Stars
124
Forks
99
PR merge metrics
No merged PRs in 30d

Description

1. This module has virtually no documentation: there is neither a high-level overview of the API, nor any haddocks for individual functions.
2. `withModule` function is partial and will throw an error `Prelude.tail: empty list` when `mdir` is `Just ""`. This must be dealt with one way or another.

https://github.com/haskell/unix/blob/b0856460e7d5ef05ab2ed851498d9f4586fda29a/System/Posix/DynamicLinker/Module.hsc#L96-L106

Contributor guide

No contributing guide indexed for this repository

Research direction

Start with System/Posix/DynamicLinker/Module.hsc, especially the withModule implementation around lines 96-106. Review the module's exported API and document its purpose and individual functions, then address the Just "" case and verify that withModule no longer fails with Prelude.tail: empty list.

Written by the indexing model from the issue text.

Assessment

Tech stack
haskell
Domain
operating-systems
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 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.