-
Notifications
You must be signed in to change notification settings - Fork 162
Add a public initializer to RenderContentMetadata #1337
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
patshaughnessy
wants to merge
3
commits into
swiftlang:main
Choose a base branch
from
patshaughnessy:r164210651-add-public-initializer-RenderContentMetadata
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,27 @@ | ||
| /* | ||
| This source file is part of the Swift.org open source project | ||
|
|
||
| Copyright (c) 2025 Apple Inc. and the Swift project authors | ||
| Licensed under Apache License v2.0 with Runtime Library Exception | ||
|
|
||
| See https://swift.org/LICENSE.txt for license information | ||
| See https://swift.org/CONTRIBUTORS.txt for Swift project authors | ||
| */ | ||
|
|
||
| // Import SwiftDocC without the @testable annotation, so we can test | ||
| // whether various API are actually public. | ||
| import SwiftDocC | ||
|
|
||
| import XCTest | ||
|
|
||
| class PublicAPITests: XCTestCase { | ||
|
|
||
| func testPublicRenderContentMetadataInitializer() throws { | ||
| let _ = RenderContentMetadata( | ||
| anchor: "anchor", | ||
| title: "title", | ||
| abstract: [], | ||
| deviceFrame: "device frame" | ||
| ) | ||
| } | ||
| } |
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.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It's fine to have this test but I don't find it important to test that initializers set the properties of a structure because the compiler will already enforce that the initializer assigns a value to every property.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thinking about this unit test some more, I've decided to rename & move the Swift file and test class to something more generic. I think this test file could be generally useful in the future for testing public access to various DocC API.
See: c587ac9
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't think running a test is a good mechanism for verifying that a piece of API is public. To my knowledge we don't do that for any other public API.
I personally don't think that having this test will meaningfully help us remember to make other future API in other types public and I think that the odds that this test protects us against unintentionally removing this API or changing it to a lower access level is abysmal.
I don't think it's harmful to have this test but I think the value it adds is fairly close to zero.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
To clarify; I'm not requesting that we remove this test, but I feel that the discussion around adding it has already cost more time and productivity that we'll ever regain from having this test.