Proc::Async page doesn't mention stdout/stderr/Supply candidates with :enc + :translate-nl

Open Beginner friendly
#4,798 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

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

Research direction

Start with the Proc::Async documentation page and review the entries for stdout, stderr, and Supply alongside new. Check the implementation's proto methods to confirm the :bin, :enc, and :translate-nl options. Done means the documentation explains these candidates' supported options consistently with the implementation.

Written by the indexing model from the issue text.

Description

in method new it says:

The :enc specifies the encoding for streams (can still be overridden in individual methods) and defaults to utf8.

but the text for methods stdout, stderr, and Supply don't have anything about that.

The implementation has a proto method for each of these that either takes a :bin (can be False which forwards to the method without :bin) or :$enc and :$translate-nl.

These should be in the docs page for Proc::Async as well.

Dominant language
Raku
Stars
308
Forks
288
Avg merge
3d 49m
Merged PRs (30d)
2

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.

More from Raku/doc

All issues in Raku/doc

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.