Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Incorrect or confusing documentation about Swift versions #677

Open
2 tasks done
rgoldberg opened this issue Oct 31, 2024 · 0 comments · May be fixed by #678
Open
2 tasks done

Incorrect or confusing documentation about Swift versions #677

rgoldberg opened this issue Oct 31, 2024 · 0 comments · May be fixed by #678

Comments

@rgoldberg
Copy link
Contributor

Swift Argument Parser 1.3.0+ only supports Swift 5.7+.

The Markdown documentation sometimes mentions Swift 5.5 when it should mention 5.7.

Documentation about the use of obsolete versions of Swift Argument Parser to support Swift 5.5 should indicate that the information is for obsolete versions.

Some of the associated documentation is imprecisely worded. Should be rewritten to clarify.

I won't list out the exact documentation issues here as I already have a branch ready to submit as a PR.

ArgumentParser version:
main branch

Checklist

  • If possible, I've reproduced the issue using the main branch of this package
  • I've searched for existing GitHub issues

Steps to Reproduce

Read the documentation. Notice incorrect or confusing information about Swift versions.

Expected behavior

Not seeing incorrect or confusing documentation about Swift versions.

Actual behavior

Seeing incorrect or confusing documentation about Swift versions.
rgoldberg added a commit to rgoldberg/swift-argument-parser that referenced this issue Oct 31, 2024
@rgoldberg
Fix incorrect or confusing documentation about Swift versions
e7369ac 
Rewrote Markdown to properly specify Swift 5.7 instead of 5.5,
and to clarify other information related to Swift versions.

Resolve apple#677

Signed-off-by: Ross Goldberg <484615+rgoldberg@users.noreply.github.com>
@rgoldberg rgoldberg linked a pull request Oct 31, 2024 that will close this issue
Open
4 tasks
rgoldberg added a commit to rgoldberg/swift-argument-parser that referenced this issue Nov 24, 2024
@rgoldberg
Fix incorrect or confusing documentation about Swift versions
b63295d 
Rewrote Markdown to properly specify Swift 5.7 instead of 5.5,
and to clarify other information related to Swift versions.

Resolve apple#677

Signed-off-by: Ross Goldberg <484615+rgoldberg@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Fix incorrect or confusing documentation about Swift versions rgoldberg/swift-argument-parser
1 participant
@rgoldberg