Skip to content

Fix incorrect or confusing documentation about Swift versions#678

Merged
natecook1000 merged 1 commit into
apple:mainfrom
rgoldberg:677-swift-version-documentation
Dec 5, 2024
Merged

Fix incorrect or confusing documentation about Swift versions#678
natecook1000 merged 1 commit into
apple:mainfrom
rgoldberg:677-swift-version-documentation

Conversation

@rgoldberg
Copy link
Copy Markdown
Contributor

@rgoldberg rgoldberg commented Oct 31, 2024

Fix incorrect or confusing documentation about Swift versions

Rewrote Markdown to properly specify Swift 5.7 instead of 5.5, and to clarify other information related to Swift versions.

Resolve #677

Checklist

  • I've added at least one test that validates that my change is working, if appropriate
  • I've followed the code style of the rest of the project
  • I've read the Contribution Guidelines
  • I've updated the documentation if necessary

@@ -29,14 +29,22 @@ struct CountLines: AsyncParsableCommand {

### Usage in Swift 5.5
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@natecook1000 what do you think about just dropping this content from the docs? Current ArgumentParser doesn't support 5.5 and users of a version that does can reference older documentation instead.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@rauhul @natecook1000 What can I do to move this forward?

Thanks.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@rauhul @natecook1000 I'll be happy to modify this PR however you want to get it resolved.

If you're not sure if you want to delete the 5.5 instructions, it might make sense to accept this PR as is, since it improves the 5.5 instructions. You can then decide whether to keep or delete the 5.5 instructions at your leisure, but at least everything will be updated in the meantime.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Apologies for the delay on this, @rgoldberg! I think Rauhul is right that we don't need this in the mainline docs anymore, but I don't want it to completely disappear. I can't decide between making a separate article and sticking in the changelog, so why don't we get this merged and I can move it later on.

Thanks!

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for merging this!

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 force-pushed the 677-swift-version-documentation branch from e7369ac to b63295d Compare November 24, 2024 11:10
@natecook1000 natecook1000 enabled auto-merge (squash) December 4, 2024 22:59
@natecook1000
Copy link
Copy Markdown
Member

@swift-ci Please test

@natecook1000 natecook1000 merged commit 41d58ff into apple:main Dec 5, 2024
@rgoldberg rgoldberg deleted the 677-swift-version-documentation branch December 5, 2024 07:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Incorrect or confusing documentation about Swift versions

3 participants