Better documentation for unGetTChan

Open Beginner friendly
#95 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
78/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Quiet
Tech stack
haskell
Domain
documentation

Research direction

Start with the documentation for unGetTChan and compare it with dupTChan and cloneTChan, using the source if needed to confirm the stated relationship. Done means the public documentation explicitly explains whether unGetTChan affects the original channel, its duplicates, and its clones.

Written by the indexing model from the issue text.

Description

As far as I can tell, there's no documentation about the relationship between unGetTChan and dupTChan/cloneTChan. My understanding is that unGetTChan only affects the channel and not its duplicates/clones, but users shouldn't have to read the source to discover that.

Dominant language
Haskell
Stars
118
Forks
41
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

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.

More from haskell/stm

All issues in haskell/stm

Similar issues

More Haskell issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.