docs: explain dynamic CSV columns - #176
Conversation
5098057 to
f046f41
Compare
There was a problem hiding this comment.
🟡 Changes recommended
The new documentation example currently performs per-field linear scans for every row, which can mislead users into a slow export pattern for large dynamic datasets.
Once you've addressed the issues Copilot identified, you can request another Copilot review.
Pull request overview
Adds README guidance for Comma exports whose columns and headers are determined at runtime, by showing an isolated per-export format that materializes the field list once, generates runtime headers, and reads associated values by field key.
Changes:
- Document a “Dynamic columns” pattern that isolates a
commaformat to a per-export row class to avoid cross-export format redefinition. - Provide a self-contained example using
__static_column__for runtime header labels and per-field value extraction from associated records.
File summaries
| File | Description |
|---|---|
| README.md | Adds a new “Dynamic columns” section with an end-to-end example for runtime-defined columns/headers. |
Review details
- Files reviewed: 1/1 changed files
- Comments generated: 1
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
There was a problem hiding this comment.
🟢 Approval recommended
The change is documentation-only and the remaining feedback is minor wording/formatting cleanup rather than correctness or behavior issues.
Review details
Suppressed comments (1)
README.md:147
- There are three consecutive blank lines here; keep a single blank line between sections to avoid unnecessary vertical whitespace in the README.
- Files reviewed: 1/1 changed files
- Comments generated: 1
- Review effort level: Lite
f046f41 to
e136835
Compare
There was a problem hiding this comment.
🟢 Approval recommended
Documentation-only change with a self-consistent example that matches the gem’s __static_column__ behavior and addresses the stated issue.
Review details
- Files reviewed: 1/1 changed files
- Comments generated: 0 new
- Review effort level: Lite
There was a problem hiding this comment.
🟢 Approval recommended
The change is documentation-only, and the added example aligns with Comma’s actual __static_column__ behavior for headers and row values.
Review details
- Files reviewed: 1/1 changed files
- Comments generated: 0 new
- Review effort level: Lite
There was a problem hiding this comment.
🟢 Approval recommended
The documentation change aligns with Comma’s extractor behavior and provides a correct, isolated example for runtime-defined columns without introducing code changes.
Review details
- Files reviewed: 1/1 changed files
- Comments generated: 0 new
- Review effort level: Lite
e136835 to
8267b93
Compare
There was a problem hiding this comment.
🟢 Approval recommended
The change is documentation-only, the example aligns with Comma’s actual extractor behavior, and prior review concerns appear addressed in the current diff.
Review details
- Files reviewed: 1/1 changed files
- Comments generated: 0 new
- Review effort level: Lite
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
8267b93 to
9225a15
Compare
Closes #157
Documents an isolated, per-export Comma format for runtime-defined columns and renamed headers. The example materializes fields once, uses
__static_column__for runtime headers, and reads associated values by field key.Tests:
bundle exec rspec spec