Skip to content

normalize abstracts and help content for swift commands #8566

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.

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

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

heckj
Copy link
Member

@heckj heckj commented Apr 28, 2025

Normalizes the structure of abstracts and the help content for commands

Motivation:

The results from --help commands were inconsistent over the past years of organic growth.

Modifications:

All command help and abstracts strings now use sentence casing and punctuation.

@heckj
Copy link
Member Author

heckj commented Apr 28, 2025

@swift-ci please test

@heckj heckj self-assigned this Apr 28, 2025
@heckj heckj changed the title Normalize help content normalize abstracts and help content for swift commands Apr 28, 2025
@heckj heckj force-pushed the normalize-help-content branch from c9c7f2c to bb44165 Compare April 28, 2025 19:25
@heckj
Copy link
Member Author

heckj commented Apr 28, 2025

@swift-ci please test

@bripeticca
Copy link
Contributor

Overall looks great to me! However I think some of the tests may need to be updated since I know there's a few that compare against the generated help text, which will have changed with this :)

So far according to the builds, I see failures in Tests/CommandsTests/PackageCommandTests, specifically the testCompletionTool test. I can clone this locally and do a pass on the tests there as well!

@heckj
Copy link
Member Author

heckj commented Apr 29, 2025

@bripeticca Local testing is showing just the one needed to be updated - and that's sorted with the latest commit. Should be good to go now, we'll see how CI does...

@heckj
Copy link
Member Author

heckj commented Apr 29, 2025

@swift-ci please test

@heckj heckj requested a review from bripeticca April 29, 2025 23:19
@bripeticca
Copy link
Contributor

@swift-ci please test

@bripeticca
Copy link
Contributor

Not sure why the tests didn't trigger yesterday @heckj :( I just re-triggered them!

heckj and others added 3 commits May 1, 2025 11:17
- Update help content to full sentences with punctuation.
- Update command abstracts to full sentences with punctuation.
@heckj heckj force-pushed the normalize-help-content branch from 33cce5e to 85f5d1e Compare May 1, 2025 18:17
@heckj
Copy link
Member Author

heckj commented May 1, 2025

rebased them up over main (over bdfd754) to see if that resolves the testing issues

@heckj
Copy link
Member Author

heckj commented May 1, 2025

@swift-ci please test

@heckj
Copy link
Member Author

heckj commented May 1, 2025

@swift-ci smoke test please

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants