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

Fix documentation bugs (formats) #790

Merged
merged 3 commits into from
Mar 29, 2022
Merged

Conversation

oscarb
Copy link
Contributor

@oscarb oscarb commented Mar 9, 2022

Issue #, if available:

Description of changes:
Fixes to documentation:

Before
image

After (previewing of markdown in Visual Studio after running npm run generate-docs)
image

Not sure if I should include the generated .docs/formats.md in this PR... but I guess it will be overwritten anyway when building the release, right?

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

@oscarb
Copy link
Contributor Author

oscarb commented Mar 9, 2022

I just realized there's one more thing that needs fixing, the parameters table for getTypeScriptType doesn't render properly. I'll see if I can fix that too while I'm at it.

@oscarb
Copy link
Contributor Author

oscarb commented Mar 9, 2022

New commit pushed to fix the rendering of the parameter list for getTypeScriptType

I've updated the image in my original post to reflect the changes

Copy link
Collaborator

@chazzmoney chazzmoney left a comment

Choose a reason for hiding this comment

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

LGTM! :shipit:

Copy link
Member

@dbanksdesign dbanksdesign left a comment

Choose a reason for hiding this comment

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

LGTM! Thank you for catching this!

@chazzmoney chazzmoney merged commit cd0e8f7 into amzn:main Mar 29, 2022
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