CodeForPhilly / CodeForPhilly/codeforphilly-ng
import-laddr: --limit semantics need a --help doc
- Ngôn ngữ chính
- TypeScript
- Star
- 1
- Fork
- 1
- Merge trung bình
- 5 ngày 3 giờ
- Pull request đã merge (30 ngày)
- 9
Mô tả
\`--limit=N\` truncates per-table to N *imported* rows, but the report still counts pre-limit rows under \`input\`, so \`imported + skipped + errors < input\` when the flag is in play. This is intentional — dry-run reports should reflect the dump's actual size — but may surprise staff scanning a report.
Once we settle on a CLI help framework (in apps/api/scripts/), document:
- \`--limit\` precisely (per-table cap on imported rows; input still counts dump size)
- All the other flags
- The 7-commit pattern + idempotence semantics
Filed as Follow-up from PR #24 (laddr-import).
Hướng dẫn đóng góp
Chưa lập chỉ mục được hướng dẫn đóng góp cho kho mã nguồn này
Hướng nghiên cứu
Start in apps/api/scripts/ and review PR #24 for the laddr-import entry point, existing flags, and the 7-commit and idempotence semantics. After the CLI help framework is settled, document --limit and the remaining flags, with completion marked by help text that accurately explains report counts and import behavior.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Đánh giá
- Công nghệ
- typescript
- Lĩnh vực
- cli, documentation
- Loại issue
- Tài liệu
- Độ khó
- 4/5
- Thời gian dự kiến
- 3-5 ngày
- Mức độ hoạt động
- Ít trao đổi
- Độ rõ ràng
- Khá rõ ràng
- Mức phù hợp với người mới
- 45/100