roc-lang / roc-lang/examples

remove readargs from Arithmetic example

Open
#40 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

In line with the goal "The code snippet of the example should concisely provide the code that the user is looking for.", readargs should not be demonstrated in the Arithmetic example. We should just use fixed values instead of cli args.

We should have another example to demonstrate command line args: https://github.com/roc-lang/examples/issues/39

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

Locate the Arithmetic example in this repository and inspect how it currently uses readargs. Replace the command-line argument demonstration with fixed values, then verify that the example is concise and no longer demonstrates CLI arguments; the separate examples issue can cover that use case.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Refactor
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.