Skip to content

Commit f982c41

Browse files
authored
Update deprecation messages to give the API a full minor release before being removed (#1310)
1 parent c1baea3 commit f982c41

File tree

2 files changed

+5
-5
lines changed

2 files changed

+5
-5
lines changed

Sources/SwiftDocC/Checker/Checkers/AbstractContainsFormattedTextOnly.swift

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ public import Markdown
1414
/**
1515
A document's abstract may only contain formatted text. Images and links are not allowed.
1616
*/
17-
@available(*, deprecated, message: "This check is no longer applicable. This deprecated API will be removed after 6.3 is released")
17+
@available(*, deprecated, message: "This check is no longer applicable. This deprecated API will be removed after 6.4 is released")
1818
public struct AbstractContainsFormattedTextOnly: Checker {
1919
public var problems: [Problem] = [Problem]()
2020
private var sourceFile: URL?

Sources/SwiftDocC/LinkTargets/LinkDestinationSummary.swift

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -226,7 +226,7 @@ public struct LinkDestinationSummary: Codable, Equatable {
226226
/// If the summarized element has a declaration but the variant doesn't, this property will be `Optional.some(nil)`.
227227
public let subheadingDeclarationFragments: VariantValue<DeclarationFragments?>
228228

229-
@available(*, deprecated, renamed: "subheadingDeclarationFragments", message: "Use 'subheadingDeclarationFragments' instead. This deprecated API will be removed after 6.3 is released.")
229+
@available(*, deprecated, renamed: "subheadingDeclarationFragments", message: "Use 'subheadingDeclarationFragments' instead. This deprecated API will be removed after 6.4 is released.")
230230
public var declarationFragments: VariantValue<DeclarationFragments?> {
231231
subheadingDeclarationFragments
232232
}
@@ -241,7 +241,7 @@ public struct LinkDestinationSummary: Codable, Equatable {
241241
/// Images that are used to represent the summarized element or `nil` if the images are the same as the summarized element.
242242
///
243243
/// If the summarized element has an image but the variant doesn't, this property will be `Optional.some(nil)`.
244-
@available(*, deprecated, message: "`TopicRenderReference` doesn't support variant specific topic images. This property will be removed after 6.3 is released")
244+
@available(*, deprecated, message: "`TopicRenderReference` doesn't support variant specific topic images. This property will be removed after 6.4 is released")
245245
public let topicImages: VariantValue<[TopicImage]?> = nil
246246

247247
/// Creates a new summary variant with the values that are different from the main summarized values.
@@ -284,7 +284,7 @@ public struct LinkDestinationSummary: Codable, Equatable {
284284
self.navigatorDeclarationFragments = navigatorDeclarationFragments
285285
}
286286

287-
@available(*, deprecated, renamed: "init(traits:kind:language:relativePresentationURL:title:abstract:taskGroups:usr:plainTextDeclaration:subheadingDeclarationFragments:navigatorDeclarationFragments:)", message: "Use `init(traits:kind:language:relativePresentationURL:title:abstract:taskGroups:usr:plainTextDeclaration:subheadingDeclarationFragments:navigatorDeclarationFragments:)` instead. `TopicRenderReference` doesn't support variant specific topic images. This property will be removed after 6.3 is released")
287+
@available(*, deprecated, renamed: "init(traits:kind:language:relativePresentationURL:title:abstract:taskGroups:usr:plainTextDeclaration:subheadingDeclarationFragments:navigatorDeclarationFragments:)", message: "Use `init(traits:kind:language:relativePresentationURL:title:abstract:taskGroups:usr:plainTextDeclaration:subheadingDeclarationFragments:navigatorDeclarationFragments:)` instead. `TopicRenderReference` doesn't support variant specific topic images. This property will be removed after 6.4 is released")
288288
public init(
289289
traits: [RenderNode.Variant.Trait],
290290
kind: VariantValue<DocumentationNode.Kind> = nil,
@@ -375,7 +375,7 @@ public struct LinkDestinationSummary: Codable, Equatable {
375375
self.variants = variants
376376
}
377377

378-
@available(*, deprecated, renamed: "init(kind:language:relativePresentationURL:referenceURL:title:abstract:availableLanguages:platforms:taskGroups:usr:plainTextDeclaration:subheadingDeclarationFragments:navigatorDeclarationFragments:redirects:topicImages:references:variants:)", message: "Use `init(kind:language:relativePresentationURL:referenceURL:title:abstract:availableLanguages:platforms:taskGroups:usr:plainTextDeclaration:subheadingDeclarationFragments:navigatorDeclarationFragments:redirects:topicImages:references:variants:)` instead. This property will be removed after 6.3 is released")
378+
@available(*, deprecated, renamed: "init(kind:language:relativePresentationURL:referenceURL:title:abstract:availableLanguages:platforms:taskGroups:usr:plainTextDeclaration:subheadingDeclarationFragments:navigatorDeclarationFragments:redirects:topicImages:references:variants:)", message: "Use `init(kind:language:relativePresentationURL:referenceURL:title:abstract:availableLanguages:platforms:taskGroups:usr:plainTextDeclaration:subheadingDeclarationFragments:navigatorDeclarationFragments:redirects:topicImages:references:variants:)` instead. This property will be removed after 6.4 is released")
379379
public init(
380380
kind: DocumentationNode.Kind,
381381
language: SourceLanguage,

0 commit comments

Comments
 (0)