swift-argument-parser icon indicating copy to clipboard operation
swift-argument-parser copied to clipboard
verified publisher icon apple

docs: update help text for readability in Repeat example and README

Open Konstantin-Krokhin opened this issue 6 months ago • 1 comments

Changes

  • Updated help text in Repeat.swift and README for better readability.

Motivation

The current help text is slightly unclear; this improves UX for new users.

Checklist

  • [x] I’ve followed the code style of the rest of the project
  • [x] I’ve updated the documentation (README and inline help text)
  • [ ] I’ve added tests (if applicable)
  • [x] I’ve read the Contribution Guidelines

Konstantin-Krokhin avatar May 30 '25 02:05 Konstantin-Krokhin

@Konstantin-Krokhin This looks great, but unfortunately we have a few tests that include the help output of the repeat command. Can you update your PR?

natecook1000 avatar Jun 02 '25 20:06 natecook1000

Thanks, @natecook1000 ! I’ve updated the test expectations in RepeatExampleTests.swift to reflect the new help text. All 522 tests are now passing.

Konstantin-Krokhin avatar Aug 01 '25 16:08 Konstantin-Krokhin

@natecook1000, please approve the workflow. Thank you.

Konstantin-Krokhin avatar Aug 18 '25 02:08 Konstantin-Krokhin

@swift-ci please test

heckj avatar Aug 18 '25 15:08 heckj