Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.

Summary
Fix several README example issues that can break first-time onboarding.
Reproduction
The README included example snippets with a missing comma, an incorrect API class name, an incomplete
catch(...)chain, and a malformed fenced code block terminator.Analysis
The generated SDK exports
ImagesApi, but one README example mixedImageApiandImagesApi. The same section also had an incomplete promise chain. Separately, thecreateProfileexample had invalid object syntax as shown, and the organizational helpers example closed with four backticks.Patch Summary
createProfileexample syntax/indentationImagesApi);in the image uploadcatch(...)chainRisks
Low. The change is limited to documentation snippets and a lightweight README validation test.
Test Coverage
tests/check-readme-examples.js