leanprover / leanprover/fp-lean

Consider clarifying the status of stdin/stdout when they first appear

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

Nobody has claimed this yet.

Confusing
Dominant language
Lean
Stars
192
Forks
73
PR merge metrics
No merged PRs in 30d

Description

It's been confusing for at least one reader - the text probably assumes more knowledge of Unix lore than it should.

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 first discussion of stdin and stdout in the project text and read the surrounding explanation. Clarify their status for readers without Unix background, then verify that the revised passage explains the concepts without assuming prior Unix knowledge.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.