Skip to content

misc: render code examples as link (api ref docs) #1557

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

Merged
merged 2 commits into from
Apr 1, 2025
Merged

misc: render code examples as link (api ref docs) #1557

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f2319bd
misc: render code examples as link (api ref docs)
0marperez Apr 1, 2025
55cd31b
end with period
0marperez Apr 1, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions .../aws-sdk-codegen/src/main/kotlin/aws/sdk/kotlin/codegen/ModuleDocumentationIntegration.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,8 +112,7 @@ class ModuleDocumentationIntegration(
?.value

appendLine("## Code Examples")
append("To see full code examples, see the ${title ?: sdkId} examples in the AWS code example library. ")
appendLine("See $codeExampleLink")
appendLine("Explore code examples for ${title ?: sdkId} in the <a href=\"$codeExampleLink\">AWS code example library</a>")
appendLine()
Copy link
Contributor

@ianbotsf ianbotsf Apr 1, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: Terminate the sentence with a period (.).

}
}
Expand Down
2 changes: 1 addition & 1 deletion ...-sdk-codegen/src/test/kotlin/aws/sdk/kotlin/codegen/ModuleDocumentationIntegrationTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ class ModuleDocumentationIntegrationTest {
.shouldContainOnlyOnceWithDiff(
"""
## Code Examples
To see full code examples, see the Test Service examples in the AWS code example library. See https://example.com
Explore code examples for Test Service in the <a href="https://example.com">AWS code example library</a>
""".trimIndent(),
)
}
Loading