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 note for Tagged Unions #7205

Merged
merged 1 commit into from
Aug 26, 2022
Merged

Add note for Tagged Unions #7205

merged 1 commit into from
Aug 26, 2022

Conversation

hssyoo
Copy link
Contributor

@hssyoo hssyoo commented Aug 18, 2022

Services and botocore support Tagged Union structures. The purpose of this PR is to enhance the CLI docs by generating a usage note for Tagged Union structures. Because Tagged Union structures can be nested under other complex types, the change needed to be made for nested options, in addition to top level options.

Preview of changes:
image

@hssyoo hssyoo force-pushed the doc-tagged-unions branch from e55927f to dd9acda Compare August 18, 2022 20:45
@codecov-commenter
Copy link

codecov-commenter commented Aug 18, 2022

Codecov Report

Merging #7205 (15472bf) into develop (d95a1a8) will decrease coverage by 0.00%.
The diff coverage is 0.00%.

@@            Coverage Diff             @@
##           develop   #7205      +/-   ##
==========================================
- Coverage     0.08%   0.08%   -0.01%     
==========================================
  Files          205     205              
  Lines        16424   16438      +14     
==========================================
  Hits            14      14              
- Misses       16410   16424      +14     
Impacted Files Coverage Δ
awscli/clidocs.py 0.00% <0.00%> (ø)
awscli/utils.py 0.00% <0.00%> (ø)

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

Copy link
Contributor

@kyleknap kyleknap left a comment

Choose a reason for hiding this comment

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

Looks good! I just had a couple of suggestions.

Copy link
Contributor

@kyleknap kyleknap left a comment

Choose a reason for hiding this comment

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

Looks good! Other than the comment on using the DenormalizedStructureBuilder, just had one more comment. It also may be worth rebasing this off of develop. It looks like there may be some merge conflicts.

Auto-generate a note for Tagged Union structures
in the docs that instructs users to only set
one of the possible top level keys.
@hssyoo hssyoo force-pushed the doc-tagged-unions branch from 3927a67 to 15472bf Compare August 26, 2022 14:06
Copy link
Contributor

@kyleknap kyleknap left a comment

Choose a reason for hiding this comment

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

Looks great! 🚢

@kyleknap kyleknap merged commit 9677fd4 into aws:develop Aug 26, 2022
@hssyoo hssyoo deleted the doc-tagged-unions branch August 26, 2022 16:23
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.

3 participants