kowainik / kowainik/relude

Based on what criteria do some Relude functions use String over Text?

Open
#424 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Haskell
Stars
742
Forks
80
PR merge metrics
No merged PRs in 30d

Description

Hi! I've started using Relude and noticed that quite a few functions use `String` over `Text`. In my particular case I used `getArgs` which returns `[String]`, `die` which takes a `String` and `readEither` which takes a `String`. The documentation says `Text` is preferred over `String` but doesn't really specify when `String` is considered appropriate regardless. I'm curious as to what the rationale is, and if those functions can be changed to use `Text`, I can try making the PR.

Contributor guide

Open the contributing guide

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 reviewing the `getArgs`, `die`, and `readEither` entry points and the documentation describing `String` and `Text`. Determine and document the rationale for their current types, including whether changing them is intended; done means the criteria and any change scope are agreed.

Written by the indexing model from the issue text.

Assessment

Tech stack
haskell
Domain
tooling
Issue type
Documentation
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.