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

Fixes for generated docs #920

Merged
merged 7 commits into from
Dec 2, 2021
Merged

Fixes for generated docs #920

merged 7 commits into from
Dec 2, 2021

Conversation

rcoh
Copy link
Collaborator

@rcoh rcoh commented Dec 2, 2021

Motivation and Context

  • typo in generated docs: The other modules within this crate and not required for normal usage.
  • # Examples is always generated even when empty

Description

  • Avoid generating #Examples when no examples exist
  • Fix typo

Testing

  • generated code diff audit

Checklist

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

- Avoid generating `#Examples` when no examples exist
- Fix typo
@rcoh rcoh requested a review from a team as a code owner December 2, 2021 13:06
@github-actions
Copy link

github-actions bot commented Dec 2, 2021

A new generated diff is ready to view: __generated-main...__generated-docs-fixes

@github-actions
Copy link

github-actions bot commented Dec 2, 2021

A new generated diff is ready to view: __generated-main...__generated-docs-fixes

@github-actions
Copy link

github-actions bot commented Dec 2, 2021

A new generated diff is ready to view: __generated-main...__generated-docs-fixes

1 similar comment
@github-actions
Copy link

github-actions bot commented Dec 2, 2021

A new generated diff is ready to view: __generated-main...__generated-docs-fixes

@github-actions
Copy link

github-actions bot commented Dec 2, 2021

A new generated diff is ready to view: __generated-main...__generated-docs-fixes

@rcoh rcoh enabled auto-merge (squash) December 2, 2021 20:35
@github-actions
Copy link

github-actions bot commented Dec 2, 2021

A new generated diff is ready to view: __generated-main...__generated-docs-fixes

@rcoh rcoh merged commit 88fc768 into main Dec 2, 2021
@rcoh rcoh deleted the docs-fixes branch December 2, 2021 20:52
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.

2 participants