Skip to content
This repository has been archived by the owner on Jun 28, 2024. It is now read-only.

[Feedback] add additional comments at the top of generated files #356

Open
julpat opened this issue Aug 15, 2023 · 1 comment
Open

[Feedback] add additional comments at the top of generated files #356

julpat opened this issue Aug 15, 2023 · 1 comment
Assignees

Comments

@julpat
Copy link
Contributor

julpat commented Aug 15, 2023

Feedback

When users are discovering generated files, they miss the context, purpose, and relations of these files right away. They are forced to google/go to documentation and lose the flow.

Possible solution

To help with that add brief comments at the top of each generated file. It will describe the purpose and relations with other files (where is it in the Superface), link to the glossary, and indicate usage (profile to change inputs/outputs; map to debug integration; ..).

@julpat julpat self-assigned this Aug 15, 2023
@Jakub-Vacek
Copy link
Member

This might be complicated for provider definition (JSON) but otherwise should be ok (Engine adding Comlink/JS comment on top of each generated file)

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants