Update docs for non aws-config config builders #3960
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
New addition notes that that configs created from these will not have the same safe defaults as aws-config
|
A new generated diff is ready to view.
A new doc preview is ready to view. |
aajtodd
approved these changes
Jan 3, 2025
| @@ -399,6 +399,7 @@ class ServiceConfigGenerator( | |||
| } | |||
|
|
|||
| fun render(writer: RustWriter) { | |||
| val configDocs = "Constructs a config builder. Note that a config created from this builder will not have the same safe defaults as one created by the [aws-config](https://crates.io/crates/aws-config) crate." | |||
There was a problem hiding this comment.
This is fine but wonder if it's worth trying to make this a callout.
I can't find a doc.rs example but I recall seeing this before and this issue seems to indicate it's possible.
/// <div class="warning">
///
/// Warning text here
///
/// </div>
IDK maybe it's not worth it?
There was a problem hiding this comment.
Updated in 4d722e1
|
A new generated diff is ready to view.
A new doc preview is ready to view. |
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
Partially addresses awslabs/aws-sdk-rust#1226, although we might want to look into going further and actually deprecating or warning on these builder methods.
Description
Testing
Doc only update
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.