feat(compogen): add extra section with --extraContents flag' #171
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
jvallesm
force-pushed
the
jvalles/compogen-inject-section
branch
from
0122dab
to
4f74266
Compare
namwoam
pushed a commit
to namwoam/component
that referenced
this pull request
Jun 24, 2024
…-ai#171) Because - Sometimes we want to extend auto-generated docs with custom content. - This is particularly true until JSON schema can be properly parsed by `compogen`, which will add more detail to the complex input / output params. This commit - Adds conent-injection capabilities to compogen. ### ℹ️ Info - You'll notice extra newlines added [everywhere](https://github.com/instill-ai/component/pull/171/files#diff-4b320521a406c97d7c1ccad3dbda779ea82206f7fdba3a7fe69c29d9834f81d0R21). I had avoided this at the cost of a less readable [template](https://github.com/instill-ai/component/pull/171/files#diff-3ddf390734accc49bc9993e2358b740523d552f9701dbadc0e2c1acaec4d97a3R51). But it is ok to have ugly auto-generated code (as long as the rendered Markdown / HTML isn't affected). What we want to read clearly is the source template and the rendered documentation. - Therefore, review is easier on a commit-by-commit basis 😇 ### Example instill-ai#172 exemplifies how to add extra sections in the Text operator.
namwoam
pushed a commit
to namwoam/component
that referenced
this pull request
Jun 24, 2024
…-ai#171) Because - Sometimes we want to extend auto-generated docs with custom content. - This is particularly true until JSON schema can be properly parsed by `compogen`, which will add more detail to the complex input / output params. This commit - Adds conent-injection capabilities to compogen. ### ℹ️ Info - You'll notice extra newlines added [everywhere](https://github.com/instill-ai/component/pull/171/files#diff-4b320521a406c97d7c1ccad3dbda779ea82206f7fdba3a7fe69c29d9834f81d0R21). I had avoided this at the cost of a less readable [template](https://github.com/instill-ai/component/pull/171/files#diff-3ddf390734accc49bc9993e2358b740523d552f9701dbadc0e2c1acaec4d97a3R51). But it is ok to have ugly auto-generated code (as long as the rendered Markdown / HTML isn't affected). What we want to read clearly is the source template and the rendered documentation. - Therefore, review is easier on a commit-by-commit basis 😇 ### Example instill-ai#172 exemplifies how to add extra sections in the Text operator.
donch1989
pushed a commit
that referenced
this pull request
Jul 2, 2024
🤖 I have created a release *beep* *boop* --- ## [0.21.0-beta](v0.20.2-beta...v0.21.0-beta) (2024-07-02) ### Features * add mail component ([#178](#178)) ([04b19d0](04b19d0)) * add read task for gcs ([#155](#155)) ([77fe2fc](77fe2fc)) * add read task in bigquery component ([#156](#156)) ([4d2e7ec](4d2e7ec)) * **anthropic:** add Anthropic component ([#176](#176)) ([030881d](030881d)) * **anthropic:** add UsageHandler functions in anthropic ([#186](#186)) ([ebaa61f](ebaa61f)) * **compogen:** add extra section with --extraContents flag' ([#171](#171)) ([391bb98](391bb98)) * **instill:** remove extra-params field ([#188](#188)) ([b17ff73](b17ff73)) * **redis:** simplify the TLS configuration ([#194](#194)) ([0a8baf7](0a8baf7)) ### Bug Fixes * **all:** fix typos ([#174](#174)) ([cb3c2fb](cb3c2fb)) * **compogen:** wrong bracket direction in substitution ([#184](#184)) ([dfe8306](dfe8306)) * expose input and output for anthropic for instill credit ([#190](#190)) ([a36e876](a36e876)) * update doc ([#185](#185)) ([6e6639a](6e6639a)) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please).
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.
Because
compogen, which will add more detail to the complex input / output params.This commit
ℹ️ Info
Example
#172 exemplifies how to add extra sections in the Text operator.