From ff3c04cc340feb4759cc75d67a646b34a82b526e Mon Sep 17 00:00:00 2001 From: Russell Cohen Date: Thu, 10 Mar 2022 09:06:08 -0500 Subject: [PATCH] Fix incorrect docstring on NamedSectionGenerator (#1228) --- .../smithy/customize/NamedSectionGenerator.kt | 14 ++------------ 1 file changed, 2 insertions(+), 12 deletions(-) diff --git a/codegen/src/main/kotlin/software/amazon/smithy/rust/codegen/smithy/customize/NamedSectionGenerator.kt b/codegen/src/main/kotlin/software/amazon/smithy/rust/codegen/smithy/customize/NamedSectionGenerator.kt index 0c13ba765..c895b66f0 100644 --- a/codegen/src/main/kotlin/software/amazon/smithy/rust/codegen/smithy/customize/NamedSectionGenerator.kt +++ b/codegen/src/main/kotlin/software/amazon/smithy/rust/codegen/smithy/customize/NamedSectionGenerator.kt @@ -24,19 +24,9 @@ import software.amazon.smithy.rust.codegen.rustlang.writable abstract class Section(val name: String) /** - * A named section generator allows customization via a predefined set of named sections. Implementors may either: - * 1. Override section and use a `when` clause to handle each section individually - * 2. Call `registerSection { ... }` to register individual sections on demand. + * A named section generator allows customization via a predefined set of named sections. * - * ```rust - * struct Config { - * /* section:ConfigStruct */ - * make_token: TokenProvider - * /* endsection:ConfigStruct */ - * } - * ``` - * - * In cases where the generated code is static, this will improve readability. + * Implementors MUST override section and use a `when` clause to handle each section individually */ abstract class NamedSectionGenerator { abstract fun section(section: T): Writable -- GitLab