feat: add example code snippet to README #809
Merged
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
there's probably an opportunity here to consolidate stuff since we call this twice
kanadgupta
added
enhancement
kanadgupta
commented
Nov 2, 2023
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.
🧰 Changes
This takes our fantastic example code snippet function and reuses it so we can populate the codegen'd SDK's README.md with example usage. If an example doesn't exist, it falls back to the existing copy:
🧬 QA & Testing
Right now we call
getExampleCodeSnippet()twice every time someone generates an SDK and I'm wondering if there's a better way for us to consolidate.But otherwise, does everything look good?