Skip to content
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.

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

Add #[doc(hidden)] to struct fields to encourage accessor use #1573

Merged
merged 10 commits into from
Aug 3, 2022

Conversation

jdisanti
Copy link
Collaborator

@jdisanti jdisanti commented Jul 26, 2022

Motivation and Context

Fixes #1569

Testing

  • Examine rustdocs for aws-sdk-s3 with these changes and make sure that both GetObjectOutput (which has a streaming member) and ListObjectsV2Output look correct
  • Manually review codegen diff

Checklist

  • I have updated CHANGELOG.next.toml if I made changes to the smithy-rs codegen or runtime crates
  • 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.

@jdisanti jdisanti requested review from a team as code owners July 26, 2022 01:18
Copy link
Contributor

@weihanglo weihanglo left a comment

Choose a reason for hiding this comment

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

This looks nice to me. Do we need any test to consolidate the change?

@github-actions
Copy link

A new generated diff is ready to view.

A new doc preview is ready to view.

Copy link
Contributor

@weihanglo weihanglo left a comment

Choose a reason for hiding this comment

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

Thanks for updating the tests!

@github-actions
Copy link

A new generated diff is ready to view.

A new doc preview is ready to view.

@jdisanti jdisanti enabled auto-merge (squash) August 2, 2022 20:50
@github-actions
Copy link

github-actions bot commented Aug 2, 2022

A new generated diff is ready to view.

A new doc preview is ready to view.

@github-actions
Copy link

github-actions bot commented Aug 3, 2022

A new generated diff is ready to view.

A new doc preview is ready to view.

@jdisanti jdisanti merged commit a2ccdf7 into main Aug 3, 2022
@jdisanti jdisanti deleted the jdisanti-doc-hidden-fields branch August 3, 2022 01:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Make public fields that have accessors #[doc(hidden)]
4 participants