Delete wrong doc comment for Package.name #8843
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This deletes a sentence from the doc comments for `Package.name` that wrongly talks about the possibility of `name` being `nil`. `Package.name` is a non-Optional property so it can never be `nil`.
ole
requested review from
bkhouri,
bripeticca,
cmcgee1024,
daveyc123,
dschaefer2,
jakepetroules,
owenv,
plemarquand and
shawnhyam
as code owners
plemarquand
approved these changes
Jun 19, 2025
Contributor
|
@swift-ci please test |
Contributor
|
@swift-ci test linux |
marcprux
pushed a commit
to swift-everywhere/swift-package-manager
that referenced
this pull request
Jul 7, 2025
Deletes a sentence from the doc comments for `Package.name` that wrongly talks about the possibility of `name` being `nil`. ### Motivation: `Package.name` is a non-Optional property so it can never be `nil`, so [the current documentation for it](https://developer.apple.com/documentation/packagedescription/package/name) is factually wrong: > The name of the Swift package. > > **Discussion** > > If the name of the package is `nil`, Swift Package Manager deduces the name of the package using its Git URL. ### Modifications: - Deleted part of a doc comment.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Deletes a sentence from the doc comments for
Package.namethat wrongly talks about the possibility ofnamebeingnil.Motivation:
Package.nameis a non-Optional property so it can never benil, so the current documentation for it is factually wrong:Modifications: