Fix tea comment docs: replace heredoc with quoted strings
Heredoc syntax causes tea comment to be backgrounded and fail silently. Updated Comments section to: - Use quoted strings with literal newlines for multiline comments - Add warning about avoiding heredoc syntax Closes #10 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
This commit was merged in pull request #11.
This commit is contained in:
@@ -119,15 +119,15 @@ tea clone <owner>/<repo> # Clone repository
|
|||||||
tea comment <number> "<comment body>"
|
tea comment <number> "<comment body>"
|
||||||
tea comment 3 "LGTM, ready to merge"
|
tea comment 3 "LGTM, ready to merge"
|
||||||
|
|
||||||
# Multiline comments (use heredoc)
|
# Multiline comments (use quoted strings with literal newlines)
|
||||||
tea comment 3 "$(cat <<'EOF'
|
tea comment 3 "## Review Summary
|
||||||
## Review Summary
|
|
||||||
- Code looks good
|
- Code looks good
|
||||||
- Tests pass
|
- Tests pass"
|
||||||
EOF
|
|
||||||
)"
|
|
||||||
```
|
```
|
||||||
|
|
||||||
|
> **Warning**: Do not use heredoc syntax `$(cat <<'EOF'...EOF)` with `tea comment` - it causes the command to be backgrounded and fail silently.
|
||||||
|
|
||||||
### Notifications
|
### Notifications
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
|
|||||||
Reference in New Issue
Block a user