Miserlou / Miserlou/Loop

README out of date

Open
#31 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Rust
Stars
697
Forks
28
PR merge metrics
No merged PRs in 30d

Description

The README makes it seem that --until-error does not require an argument:

Or until it fails with --until-error (which also accepts an optional error code):

But when I try it without an argument, I get this:

error: The argument '--until-error <until_error>' requires a value but none was supplied

USAGE:
    loop <input> --count-by <count_by> --every <every> --offset <offset> --until-error <until_error>

So I think that maybe --until-fail is what I want, based on this:

Or, if you have a list of files but need to find the one which causes your program to fail:
$ ls | loop './my_program $ITEM' --until-fail;

But I get this:

error: Found argument '--until-fail' which wasn't expected, or isn't valid in this context

And I still don't know how to run a command until it fails. Seems like it is currently impossible.

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.

Research direction

Start with the README examples for --until-error and --until-fail, then compare them with the loop command's documented help and the reported argument errors. Update the README so it only describes supported flags and accurately explains how to run a command until it fails; verify the corrected examples against the CLI.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.