Fix Readme script generation #821
Merged
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
GeorgesLorre
changed the title
|
Looking at the hub, I don't mind the underscored look. However I don't like the similarity (but not exact match) with the id, since I think this can be confusing. I would either try to use the original name, or just use the id instead. |
| @@ -21,14 +20,17 @@ def generate_readme(component_spec: ComponentSpec, *, component_dir: Path) -> st | |||
| return template.render( | |||
| id=component_dir.name, | |||
| name=component_spec.name, | |||
| component_folder_name=component_spec.component_folder_name, | |||
| component_folder_name=component_spec.name, | |||
There was a problem hiding this comment.
Can we remove the component_folder_name argument and just use the id everywhere in its place instead?
GeorgesLorre
force-pushed
the
fix/readme-generation
branch
from
a2451d0
to
a39b8b0
Compare
RobbeSneyders
approved these changes
Jan 30, 2024
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 fixes the failing builds but is it what we want ?