Update generic readme generation #737
Conversation
There was a problem hiding this comment.
Thanks @PhilippeMoussalli! Some suggestions on how to make this even more clear.
| {% if consumes %} | ||
| **This component consumes:** | ||
|
|
||
| {% for field_name, field in consumes.items() %} | ||
| - {{ field.name }}: {{ field.type.value }} | ||
| {% endfor %} | ||
| {% else %} | ||
| **This component consumes no data.** | ||
| _**This component does not consume specific data.**_ | ||
| {% endif %} | ||
|
|
||
| {% if is_consumes_generic %} | ||
| **This component consumes generic data** | ||
| - <field_name>: <mapped_field_name> | ||
| {% endif %} |
There was a problem hiding this comment.
I don't think "does not consume specific data", or "consumes generic data" is clear for users without deep knowledge about Fondant concepts. I think we can refactor this and update the messages to be more clear:
{% if consumes %}
**This component consumes:**
{% for field_name, field in consumes.items() %}
- {{ field.name }}: {{ field.type.value }}
{% endfor %}
{% elif is_consumes_generic %}
**This component can consume different data schemes**
See the usage example below on how to define a schema.
{% else %}
**This component does not consume data.**
{% endif %}
| {% if produces %} | ||
| **This component produces:** | ||
|
|
||
| {% for field_name, field in produces.items() %} | ||
| - {{ field.name }}: {{ field.type.value }} | ||
| {% endfor %} | ||
| {% else %} | ||
| **This component produces no data.** | ||
| _**This component does not produce specific data.**_ | ||
| {% endif %} | ||
|
|
||
| ### Arguments | ||
| {% if is_produces_generic %} | ||
| **This component produces generic data** | ||
| - <field_name>: <field_schema> | ||
| {% endif %} |
There was a problem hiding this comment.
Same as proposal for consumes above.
| ### Arguments | ||
| {% if is_produces_generic %} | ||
| **This component produces generic data** | ||
| - <field_name>: <field_schema> |
There was a problem hiding this comment.
The produce implementation can use both, a column mapping and a column/data type mapping. What you can use depends on the component implementation itself. Can we add a description for column name, data type mapping too?
There was a problem hiding this comment.
good call! added a description based on the docs
PhilippeMoussalli
force-pushed
the
update-generic-component-readme-generation
branch
from
7d76bfb to
c67ae37
Compare
| {% if consumes %} | ||
| **This component consumes:** | ||
|
|
There was a problem hiding this comment.
This newline is needed for formatting the list correctly.
| {% if produces %} | ||
| **This component produces:** | ||
|
|
There was a problem hiding this comment.
This newline is needed for formatting the list correctly.
PhilippeMoussalli
deleted the
update-generic-component-readme-generation
branch
Fixes #729