Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Explain tool decisions in generated output #23

Open
edsko opened this issue Aug 1, 2024 · 0 comments
Open

Explain tool decisions in generated output #23

edsko opened this issue Aug 1, 2024 · 0 comments

Comments

@edsko
Copy link
Collaborator

edsko commented Aug 1, 2024

When users use the high-level API, they might need ways to customize the generated output, sometimes perhaps even extensive customization. To make this easier, the generated output should

  • be readable (pretty-printed)
  • contain comments that explain decisions made by the tool (e.g., "rule such and such fired").

The latter especially will help users understand why the tool did what it did, and provide clues on how to modify that.

# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant