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

Use shorthand syntax for instance type #5615

Closed
wants to merge 1 commit into from
Closed

Conversation

Fydon
Copy link

@Fydon Fydon commented Oct 8, 2020

Possibly related to #484

Simplify the documentation for modify-instance-attribute by using shorthand syntax.

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

@codecov-io
Copy link

codecov-io commented Oct 8, 2020

Codecov Report

Merging #5615 into develop will decrease coverage by 0.16%.
The diff coverage is n/a.

Impacted file tree graph

@@             Coverage Diff             @@
##           develop    #5615      +/-   ##
===========================================
- Coverage    92.52%   92.36%   -0.17%     
===========================================
  Files          196      196              
  Lines        15898    15733     -165     
===========================================
- Hits         14709    14531     -178     
- Misses        1189     1202      +13     
Impacted Files Coverage Δ
awscli/compat.py 57.30% <0.00%> (-5.15%) ⬇️
awscli/commands.py 86.66% <0.00%> (-3.34%) ⬇️
awscli/customizations/ec2/decryptpassword.py 84.74% <0.00%> (-0.97%) ⬇️
awscli/arguments.py 94.23% <0.00%> (-0.77%) ⬇️
awscli/customizations/ec2/addcount.py 93.33% <0.00%> (-0.67%) ⬇️
awscli/help.py 96.19% <0.00%> (-0.29%) ⬇️
awscli/testutils.py 64.17% <0.00%> (-0.26%) ⬇️
awscli/customizations/streamingoutputarg.py 98.11% <0.00%> (-0.17%) ⬇️
awscli/clidriver.py 95.80% <0.00%> (-0.14%) ⬇️
awscli/argparser.py 94.56% <0.00%> (-0.12%) ⬇️
... and 19 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 1290a70...ecc01f2. Read the comment docs.

@kdaily kdaily added the documentation This is a problem with documentation. label Nov 3, 2020
@Fydon
Copy link
Author

Fydon commented Nov 9, 2020

I'm not sure what the next step is here. It's a one line change to documentation so I don't get why this change is blocked. Do I just need to rebase?

@kdaily
Copy link
Member

kdaily commented Nov 19, 2020

Hi @Fydon, thanks for the contribution. We try to maintain consistency for the example syntax. The more explicit example is easier to compare to the API. Given how short this example is (there is only one parameter) the change to using shorthand does not provide much more clarity.

I do realize that the specifications for how to write examples are not available in our contributing guide, and I am going to work with our doc writing team to make that available.

@kdaily kdaily closed this Nov 19, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation This is a problem with documentation.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants