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

Fixup typos in SDK documentation and examples. #3469

Merged
merged 3 commits into from
Aug 10, 2020
Merged

Fixup typos in SDK documentation and examples. #3469

merged 3 commits into from
Aug 10, 2020

Conversation

kataras
Copy link
Contributor

@kataras kataras commented Aug 8, 2020

Important misspell fixes. Carefully fixed one by one by hand.

@kataras
Copy link
Contributor Author

kataras commented Aug 8, 2020

/CC @skmcgrail @skotambkar

Note, the CI test validate no generated code changes test is failing because the generated content had misspellings too, which I fixed them too, in order to no need to rebuild those files using the new misspell-clear generator code. It's safe to leave these tests fail, in the next commit they will not fail. However, contributors are free to edit this PR and clear the generated content's misspell fixes.

Copy link
Contributor

@jasdel jasdel 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 submitting this PR @kataras to fixup the typos. We can take all of the changes except for those to the ./models/apis/*/*/doc-2.json files. These files are sourced externally to the SDK, and they need to be updated separately.

I created #3471 to track the API model updates that are needed so those typo fixes aren't lost.

@jasdel jasdel changed the title Fix 100+ misspellings Fixup typos in SDK documentation and examples. Aug 10, 2020
@kataras
Copy link
Contributor Author

kataras commented Aug 10, 2020

Sounds good @jasdel , I see that you reverted these changed already. Do you need something more by my side so we can proceed with merging? Thanks

@jasdel jasdel merged commit 375b496 into aws:master Aug 10, 2020
@jasdel
Copy link
Contributor

jasdel commented Aug 10, 2020

Everything is good, we can merge this in and it will be included in the SDK's next release. Thanks for taking the time to correct these typos!

@kataras
Copy link
Contributor Author

kataras commented Aug 11, 2020

No worries @jasdel, thanks for accepting it!

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