roc-lang / roc-lang/examples

example suggestion: Avoiding splitting a Str into characters

Open
#141 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

example suggestion
Dominant language
Shell
Stars
46
Forks
19
Avg merge
13h 38m
Merged PRs (30d)
19

Description

From the Roc Str reference:

If it seems like a good idea to split a string into "characters" (graphemes), you should definitely stop and reconsider whether this is really the best design. Almost always, doing this is some combination of more error-prone or slower (usually both) than doing something else that does not require taking graphemes into consideration.

It would be good to have several snippets that demonstrate this.

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 reading the linked Roc Str reference and reviewing the existing examples in this repository. Add several snippets demonstrating alternatives to splitting a Str into graphemes, and consider the work complete when those examples clearly illustrate the recommendation.

Written by the indexing model from the issue text.

Assessment

Domain
content, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.