Conversation
There was a problem hiding this comment.
Pull request overview
Adds a decision guide to the Templates section of the README so users can choose the simplest appropriate template return type instead of defaulting to more complex patterns.
Changes:
- Adds a “Choosing a template return type” section with a comparison table (multiple outputs, custom filename, and recommended usage).
- Adds brief guidance encouraging starting with string returns and escalating only when needed.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
The previous description implied AsyncIterator was needed for any async work, which is wrong -- all template forms support async functions. The distinguishing characteristic is streaming/dynamic number of outputs.
Coverage Report for CI Build 24611719140Coverage remained the same at 91.469%Details
Uncovered ChangesNo uncovered changes found. Coverage RegressionsNo coverage regressions found. Coverage Stats
💛 - Coveralls |
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 1 out of 1 changed files in this pull request and generated 1 comment.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 1 out of 1 changed files in this pull request and generated no new comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Closes #231
The README documents all four template return types with full examples but presents them as equal options. Without guidance, users default to more complex patterns (array returns for single-file templates) when simpler ones would do.
This adds a "Choosing a template return type" comparison table before the RSS Feed Template Example. The table maps each return type to whether it supports multiple outputs, a custom filename, and when to reach for it. The guidance is: start with a string return and only switch to something more complex when you need what it provides.