Label Sample-Code Call-to-Action buttons with "View Source" #566
+122
−82
Conversation
This file contains 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
Updates the logic for `@CallToAction` buttons that are attached to `sampleCode` pages and use the `link` purpose to render with a more specific “View Source” title instead of the more generic “Visit” title. This makes the intent of the button more clear. Resolves rdar://108013602
ethan-kusters
requested review from
d-ronnqvist,
QuietMisdreavus,
franklinsch and
daniel-grumberg
|
@swift-ci please test |
d-ronnqvist
approved these changes
Apr 25, 2023
| @@ -178,6 +197,7 @@ extension CallToAction { | |||
| extension CallToAction.Purpose { | |||
| /// The label that will be applied to a Call to Action with this purpose if it doesn't provide | |||
| /// a separate label. | |||
| @available(*, deprecated, message: "Replaced with 'CallToAction.buttonLabel(for:)'.") | |||
| public var defaultLabel: String { | |||
There was a problem hiding this comment.
should this internally call defaultLabel(for: nil)?
There was a problem hiding this comment.
Good idea: c83c4a3.
| @@ -79,6 +81,7 @@ public final class CallToAction: Semantic, AutomaticDirectiveConvertible { | |||
|
|
|||
| /// The computed label for this Call to Action, whether provided directly via ``label`` or | |||
| /// indirectly via ``purpose``. | |||
| @available(*, deprecated, renamed: "buttonLabel(for:)") | |||
| public var buttonLabel: String { | |||
| if let label = label { | |||
There was a problem hiding this comment.
should this internally call buttonLabel(for: nil)?
There was a problem hiding this comment.
Good idea: c83c4a3.
|
@swift-ci please test |
ethan-kusters
added a commit
to ethan-kusters/swift-docc
that referenced
this pull request
Apr 26, 2023
…g#566) Updates the logic for `@CallToAction` buttons that are attached to `sampleCode` pages and use the `link` purpose to render with a more specific “View Source” title instead of the more generic “Visit” title. This makes the intent of the button more clear. Resolves rdar://108013602
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Bug/issue #, if applicable: rdar://108013602
Summary
Updates the logic for
@CallToActionbuttons that are attached tosampleCodepages and use thelinkpurpose to render with a more specific “View Source” title instead of the more generic “Visit” title.This makes the intent of the button more clear. Regular article pages should continue to have the same behavior.
Testing
Create an article with
@CallToActiondirective using that provides aurlandlinkpurpose and a@PageKind(sampleCode)directive. Confirm that the call to action button is labeled "View Source".Checklist
Make sure you check off the following items. If they cannot be completed, provide a reason.
./bin/testscript and it succeeded