Remove #[doc(hidden)] from stable crates #3226
Merged
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
|
A new generated diff is ready to view.
A new doc preview is ready to view. |
|
A new generated diff is ready to view.
A new doc preview is ready to view. |
jdisanti
reviewed
Nov 17, 2023
This commit addresses #3226 (comment)
This commit addresses #3226 (comment)
rcoh
reviewed
Nov 17, 2023
This commit addresses #3226 (comment)
… into ysaito/remove-doc-hidden
rcoh
added a commit
that referenced
this pull request
Nov 17, 2023
This PR removes `#[doc(hidden)]` from types/functions in stable crates (as defined in [CrateSet.kt](https://github.com/smithy-lang/smithy-rs/blob/ad520b080aa0a3e8239ab2857dafb519c3458088/buildSrc/src/main/kotlin/CrateSet.kt#L19-L33)). They are now `pub`, however, for those that are not intended to be used directly, we preserve the original docs to be explicit about it. After this PR, stable crates contain neither <details> <summary>#[doc(hidden)]</summary> ``` ➜ smithy-rs git:(ysaito/remove-doc-hidden) rg -l '#\[doc\(hidden\)\]' aws/rust-runtime/aws-http/src/user_agent.rs CHANGELOG.next.toml CHANGELOG.md rust-runtime/aws-smithy-http/src/lib.rs rust-runtime/aws-smithy-http/src/event_stream/sender.rs rust-runtime/aws-smithy-http/src/event_stream/receiver.rs codegen-core/src/main/kotlin/software/amazon/smithy/rust/codegen/core/smithy/generators/error/ErrorImplGenerator.kt (this is only for CodegenTarget.SERVER) codegen-core/src/test/kotlin/software/amazon/smithy/rust/codegen/core/smithy/generators/StructureGeneratorTest.kt design/src/server/instrumentation.md design/src/rfcs/rfc0039_forward_compatible_errors.md design/src/rfcs/rfc0032_better_constraint_violations.md design/src/rfcs/rfc0026_client_crate_organization.md rust-runtime/aws-smithy-http-server/src/macros.rs rust-runtime/aws-smithy-http-server/src/routing/mod.rs rust-runtime/aws-smithy-http-server/src/shape_id.rs rust-runtime/aws-smithy-http-server/src/body.rs rust-runtime/aws-smithy-http-server/src/lib.rs rust-runtime/aws-smithy-http-server/src/plugin/mod.rs codegen-server/src/main/kotlin/software/amazon/smithy/rust/codegen/server/smithy/generators/MapConstraintViolationGenerator.kt codegen-server/src/main/kotlin/software/amazon/smithy/rust/codegen/server/smithy/generators/CollectionConstraintViolationGenerator.kt ``` </details> nor <details> <summary>DocHidden</summary> ``` ➜ smithy-rs git:(ysaito/remove-doc-hidden) rg -l 'DocHidden' codegen-core/src/main/kotlin/software/amazon/smithy/rust/codegen/core/rustlang/RustType.kt codegen-server/src/main/kotlin/software/amazon/smithy/rust/codegen/server/smithy/generators/ServerBuilderConstraintViolations.kt ``` </details> <!--- If a checkbox below is not applicable, then please DELETE it rather than leaving it unchecked --> - [x] I have updated `CHANGELOG.next.toml` if I made changes to the smithy-rs codegen or runtime crates - [x] I have updated `CHANGELOG.next.toml` if I made changes to the AWS SDK, generated SDK code, or SDK runtime crates ---- _By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice._ --------- Co-authored-by: Russell Cohen <[email protected]>
rcoh
added a commit
that referenced
this pull request
Nov 17, 2023
This PR removes `#[doc(hidden)]` from types/functions in stable crates (as defined in [CrateSet.kt](https://github.com/smithy-lang/smithy-rs/blob/ad520b080aa0a3e8239ab2857dafb519c3458088/buildSrc/src/main/kotlin/CrateSet.kt#L19-L33)). They are now `pub`, however, for those that are not intended to be used directly, we preserve the original docs to be explicit about it. After this PR, stable crates contain neither <details> <summary>#[doc(hidden)]</summary> ``` ➜ smithy-rs git:(ysaito/remove-doc-hidden) rg -l '#\[doc\(hidden\)\]' aws/rust-runtime/aws-http/src/user_agent.rs CHANGELOG.next.toml CHANGELOG.md rust-runtime/aws-smithy-http/src/lib.rs rust-runtime/aws-smithy-http/src/event_stream/sender.rs rust-runtime/aws-smithy-http/src/event_stream/receiver.rs codegen-core/src/main/kotlin/software/amazon/smithy/rust/codegen/core/smithy/generators/error/ErrorImplGenerator.kt (this is only for CodegenTarget.SERVER) codegen-core/src/test/kotlin/software/amazon/smithy/rust/codegen/core/smithy/generators/StructureGeneratorTest.kt design/src/server/instrumentation.md design/src/rfcs/rfc0039_forward_compatible_errors.md design/src/rfcs/rfc0032_better_constraint_violations.md design/src/rfcs/rfc0026_client_crate_organization.md rust-runtime/aws-smithy-http-server/src/macros.rs rust-runtime/aws-smithy-http-server/src/routing/mod.rs rust-runtime/aws-smithy-http-server/src/shape_id.rs rust-runtime/aws-smithy-http-server/src/body.rs rust-runtime/aws-smithy-http-server/src/lib.rs rust-runtime/aws-smithy-http-server/src/plugin/mod.rs codegen-server/src/main/kotlin/software/amazon/smithy/rust/codegen/server/smithy/generators/MapConstraintViolationGenerator.kt codegen-server/src/main/kotlin/software/amazon/smithy/rust/codegen/server/smithy/generators/CollectionConstraintViolationGenerator.kt ``` </details> nor <details> <summary>DocHidden</summary> ``` ➜ smithy-rs git:(ysaito/remove-doc-hidden) rg -l 'DocHidden' codegen-core/src/main/kotlin/software/amazon/smithy/rust/codegen/core/rustlang/RustType.kt codegen-server/src/main/kotlin/software/amazon/smithy/rust/codegen/server/smithy/generators/ServerBuilderConstraintViolations.kt ``` </details> <!--- If a checkbox below is not applicable, then please DELETE it rather than leaving it unchecked --> - [x] I have updated `CHANGELOG.next.toml` if I made changes to the smithy-rs codegen or runtime crates - [x] I have updated `CHANGELOG.next.toml` if I made changes to the AWS SDK, generated SDK code, or SDK runtime crates ---- _By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice._ --------- Co-authored-by: Russell Cohen <[email protected]>
aws-sdk-rust-ci
pushed a commit
that referenced
this pull request
Nov 17, 2023
This PR removes `#[doc(hidden)]` from types/functions in stable crates (as defined in [CrateSet.kt](https://github.com/smithy-lang/smithy-rs/blob/ad520b080aa0a3e8239ab2857dafb519c3458088/buildSrc/src/main/kotlin/CrateSet.kt#L19-L33)). They are now `pub`, however, for those that are not intended to be used directly, we preserve the original docs to be explicit about it. After this PR, stable crates contain neither <details> <summary>#[doc(hidden)]</summary> ``` ➜ smithy-rs git:(ysaito/remove-doc-hidden) rg -l '#\[doc\(hidden\)\]' aws/rust-runtime/aws-http/src/user_agent.rs CHANGELOG.next.toml CHANGELOG.md rust-runtime/aws-smithy-http/src/lib.rs rust-runtime/aws-smithy-http/src/event_stream/sender.rs rust-runtime/aws-smithy-http/src/event_stream/receiver.rs codegen-core/src/main/kotlin/software/amazon/smithy/rust/codegen/core/smithy/generators/error/ErrorImplGenerator.kt (this is only for CodegenTarget.SERVER) codegen-core/src/test/kotlin/software/amazon/smithy/rust/codegen/core/smithy/generators/StructureGeneratorTest.kt design/src/server/instrumentation.md design/src/rfcs/rfc0039_forward_compatible_errors.md design/src/rfcs/rfc0032_better_constraint_violations.md design/src/rfcs/rfc0026_client_crate_organization.md rust-runtime/aws-smithy-http-server/src/macros.rs rust-runtime/aws-smithy-http-server/src/routing/mod.rs rust-runtime/aws-smithy-http-server/src/shape_id.rs rust-runtime/aws-smithy-http-server/src/body.rs rust-runtime/aws-smithy-http-server/src/lib.rs rust-runtime/aws-smithy-http-server/src/plugin/mod.rs codegen-server/src/main/kotlin/software/amazon/smithy/rust/codegen/server/smithy/generators/MapConstraintViolationGenerator.kt codegen-server/src/main/kotlin/software/amazon/smithy/rust/codegen/server/smithy/generators/CollectionConstraintViolationGenerator.kt ``` </details> nor <details> <summary>DocHidden</summary> ``` ➜ smithy-rs git:(ysaito/remove-doc-hidden) rg -l 'DocHidden' codegen-core/src/main/kotlin/software/amazon/smithy/rust/codegen/core/rustlang/RustType.kt codegen-server/src/main/kotlin/software/amazon/smithy/rust/codegen/server/smithy/generators/ServerBuilderConstraintViolations.kt ``` </details> <!--- If a checkbox below is not applicable, then please DELETE it rather than leaving it unchecked --> - [x] I have updated `CHANGELOG.next.toml` if I made changes to the smithy-rs codegen or runtime crates - [x] I have updated `CHANGELOG.next.toml` if I made changes to the AWS SDK, generated SDK code, or SDK runtime crates ---- _By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice._ --------- Co-authored-by: Russell Cohen <[email protected]>
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.
Motivation and Context
This PR removes
#[doc(hidden)]from types/functions in stable crates (as defined in CrateSet.kt). They are nowpub, however, for those that are not intended to be used directly, we preserve the original docs to be explicit about it.Testing
After this PR, stable crates contain neither
#[doc(hidden)]
nor
DocHidden
Checklist
CHANGELOG.next.tomlif I made changes to the smithy-rs codegen or runtime cratesCHANGELOG.next.tomlif I made changes to the AWS SDK, generated SDK code, or SDK runtime cratesBy submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.