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.

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

[SR-10803] Descriptive Help for "swift package init --type" in SPM #4701

Closed
neonichu opened this issue May 30, 2019 · 8 comments
Closed

[SR-10803] Descriptive Help for "swift package init --type" in SPM #4701

neonichu opened this issue May 30, 2019 · 8 comments
Labels
enhancement good first issue Good for newcomers Edit

Comments

@neonichu
Copy link
Member

Previous ID SR-10803
Radar rdar://problem/47951431
Original Reporter @neonichu
Type Improvement

Attachment: Download

Additional Detail from JIRA
Votes 0
Component/s Package Manager
Labels Improvement, StarterBug
Assignee Greenaway (JIRA)
Priority Medium

md5: d7d16c9fa6fbd23758e129578722fbe0

Issue Description:

The help for the command line "swift package init" command does not explain the --type option. I have to always go to the online docs on GitHub to remember I can use --type executable. At least --type is not explained in an easy to find place.
@swift-ci
Copy link
Contributor

swift-ci commented Jun 7, 2019

Comment by Arjun Nayini (JIRA)

@neonichu, As attached - it looks like `-help` will give information about the `–type` option but I'm guessing this ticket just wants even more clear prose here? Is that correct?

@swift-ci
Copy link
Contributor

swift-ci commented Jun 8, 2019

Comment by Ed (JIRA)

I am not sure if Arjun has made a PR for this ... however I have a fix that is being built and which I will test

@swift-ci
Copy link
Contributor

swift-ci commented Jun 8, 2019

Comment by Arjun Nayini (JIRA)

Yup I’ve got a PR up

@belkadan
Copy link

Did this ever get merged?

(I'm checking in on all the StarterBugs that haven't been touched in over a month; it's totally fine if it's still in progress.)

@swift-ci
Copy link
Contributor

swift-ci commented Aug 1, 2019

Comment by Ed (JIRA)

Last time I checked it had not been merged; I had left it with Arjun on Boris's suggestion as Arjun had had it initially.  I still have the fix I developed on the day, so I am happy to double-check and then submit if I get the "go ahead".

@ankitspd
Copy link
Member

ankitspd commented Aug 1, 2019

Greenaway (JIRA User) feel free to open a PR

@swift-ci
Copy link
Contributor

swift-ci commented Aug 1, 2019

Comment by Arjun Nayini (JIRA)

Sorry, was out of the country for a little bit there.

@aciidb0mb3r, Greenaway (JIRA User) - A PR up here (#2142 but @aciidb0mb3r wanted a modification at the parser level to ensure it is properly formatted regardless of terminal size. Might not be able to get around to this that quickly to be honest.

@swift-ci swift-ci transferred this issue from apple/swift-issues Apr 25, 2022
@shahmishal shahmishal transferred this issue from apple/swift May 4, 2022
@Overcot Overcot mentioned this issue May 13, 2022
Merged
@tomerd tomerd added good first issue Good for newcomers Edit enhancement and removed Package Manager labels May 14, 2022
tomerd pushed a commit that referenced this issue May 18, 2022
@Overcot
#4701 - Resolves SR-10803 (#5502)
d5fa949 
Added additional description for swift-package init -help command explaining what each type means
@Overcot
Copy link
Contributor

Overcot commented May 18, 2022

@tomerd Maybe then close this issue if it's merged?)

@tomerd tomerd closed this as completed May 18, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement good first issue Good for newcomers Edit
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
6 participants
@neonichu @tomerd @belkadan @ankitspd @Overcot @swift-ci