chore: interpolate example code in README.md for each package #40
Conversation
This file contains 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
andreszorro
approved these changes
Jun 5, 2024
This script will modify the given files (all CLI arguments passed to the script are interpreted as filenames) to interpolate example code from files. It looks for lines that look like this: [This example code](../path/to/file.ts) shows how to do X. And replaces those occurrences to look like this: This example code shows how to do X. ```ts // Contents of ../path/to/file.ts ``` This simple hack allows us to keep our code examples in separate files (which are runnable and testable in CI), while still including them inline in the documentation that gets published to npmjs.org for the packages.
jemc
force-pushed
the
chore/interpolate-example-code-in-readmes
branch
from
5e42a8b to
017cebc
Compare
InfraK
approved these changes
Jun 6, 2024
|
🎉 This PR is included in version @formula-monks/kurt-v1.3.0 🎉 The release is available on: Your semantic-release bot 📦🚀 |
|
🎉 This PR is included in version @formula-monks/kurt-open-ai-v1.5.0 🎉 The release is available on: Your semantic-release bot 📦🚀 |
|
🎉 This PR is included in version @formula-monks/kurt-vertex-ai-v1.4.0 🎉 The release is available on: Your semantic-release bot 📦🚀 |
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.
This script will modify the given files (all CLI arguments passed to the script are interpreted as filenames) to interpolate example code from files.
It looks for lines that look like this:
This example code shows how to do X.
And replaces those occurrences to look like this:
This example code shows how to do X.
// Contents of ../path/to/file.tsThis simple hack allows us to keep our code examples in separate files (which are runnable and testable in CI), while still including them inline in the documentation that gets published to npmjs.org for the packages.