Generate READMEs for all components using a script #484
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
RobbeSneyders
requested review from
mrchtr,
GeorgesLorre and
PhilippeMoussalli
There was a problem hiding this comment.
Nice :) This will save us a lot of time
Few questions:
- The defaults are not show in the argument table. Is it worth adding them (perhaps explicitly mention that those are optional) and then not showing them in the Usage section? I feel like this will show better that default arguments don't need to be passed but might be less clear
- We mention now testing but we don't have tests for every component. Can we dynamically create this segment only if we have a test for the component?
- How is this script run? is it going to be part of CI/CD or should we do it manually every time we create a component?
RobbeSneyders
commented
Oct 4, 2023
There was a problem hiding this comment.
- The defaults are not show in the argument table. Is it worth adding them (perhaps explicitly mention that those are optional) and then not showing them in the Usage section? I feel like this will show better that default arguments don't need to be passed but might be less clear
I added the defaults to the table, and commented them in the Usage section. I think this makes it clear that they are not needed while still providing an example. If no default is available, I now generate the default value of the type as an example.
- We mention now testing but we don't have tests for every component. Can we dynamically create this segment only if we have a test for the component?
Done
- How is this script run? is it going to be part of CI/CD or should we do it manually every time we create a component?
I added it to pre-commit. I think that's the most logical place since it makes changes to the code.
RobbeSneyders
force-pushed
the
feature/component_readmes
branch
from
484009f
to
c566b3b
Compare
mrchtr
approved these changes
Oct 5, 2023
Hakimovich99
pushed a commit
that referenced
this pull request
Oct 16, 2023
This PR adds a script to generate a component README from its `fondant_component.yaml`. As a next step, I'd like to add these to the documentation.
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 PR adds a script to generate a component README from its
fondant_component.yaml.As a next step, I'd like to add these to the documentation.