Skip to content

Conversation

taji-taji
Copy link
Contributor

I found what seems to be a typo in the description of the install subcommand and have corrected it.

@xtremekforever
Copy link

LOL, a double they they!

@cmcgee1024
Copy link
Member

cmcgee1024 commented Jan 27, 2025

Thank you for your contribution. Fixing the wording there will not only help with what people see when they invoke swiftly install --help, but it will also fix the DocC documentation too. https://swiftpackageindex.com/swiftlang/swiftly/0.4.0-dev/documentation/swiftlydocs/swiftly-cli-reference#install

At the moment, there is unfortunately a manual step to regenerate the documentation from the comment change. Can you run the following, commit the update the markdown and add it here?

swift package plugin generate-docs-reference

@taji-taji
Copy link
Contributor Author

@cmcgee1024
Thank you for your review!
I also updated the markdown of the document.

@cmcgee1024 cmcgee1024 merged commit 1d5d84d into swiftlang:main Jan 28, 2025
18 checks passed
@cmcgee1024
Copy link
Member

Thanks again @taji-taji

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.

3 participants