Skip to content

Delete wrong doc comment for Package.name #8843

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.

Sign up for GitHub

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
Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Delete wrong doc comment for Package.name #8843

wants to merge 1 commit into from

Conversation

ole
Copy link

@ole ole commented Jun 19, 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 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.

@ole
Delete wrong doc comment for Package.name
3054b73 
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`.
@plemarquand
Copy link
Contributor

@swift-ci please test

@plemarquand
Copy link
Contributor

@swift-ci test linux

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@plemarquand plemarquand plemarquand approved these changes

@jakepetroules jakepetroules Awaiting requested review from jakepetroules jakepetroules is a code owner

@dschaefer2 dschaefer2 Awaiting requested review from dschaefer2 dschaefer2 is a code owner

@shawnhyam shawnhyam Awaiting requested review from shawnhyam shawnhyam is a code owner

@bripeticca bripeticca Awaiting requested review from bripeticca bripeticca is a code owner

@owenv owenv Awaiting requested review from owenv owenv is a code owner

@bkhouri bkhouri Awaiting requested review from bkhouri bkhouri is a code owner

@cmcgee1024 cmcgee1024 Awaiting requested review from cmcgee1024 cmcgee1024 is a code owner

@daveyc123 daveyc123 Awaiting requested review from daveyc123 daveyc123 is a code owner

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@ole @plemarquand