Skip to content

Fix README examples: use single quotes around values containing !#3

Merged
solovey23 merged 1 commit intomailtrap:mainfrom
solovey23:fix/readme-shell-quoting
Apr 21, 2026
Merged

Fix README examples: use single quotes around values containing !#3
solovey23 merged 1 commit intomailtrap:mainfrom
solovey23:fix/readme-shell-quoting

Conversation

@solovey23
Copy link
Copy Markdown
Contributor

@solovey23 solovey23 commented Apr 21, 2026

Summary

  • Fix dquote> mode when copy-pasting README examples in bash

Problem

Bash history expansion treats ! inside double quotes specially. The two affected examples:

  • --subject "Welcome!" (Transactional sending example)
  • --body-html "<h1>Hi!</h1>" (Templates example)

When copy-pasted into an interactive bash shell, these trigger history expansion and leave the shell waiting for a closing " (dquote> prompt).

Fix

Switch to single quotes for the affected values — single quotes are always literal in bash and are the correct choice for values that don't need variable interpolation.

Test plan

  • Copy-paste the updated examples directly into a bash terminal — no dquote> prompt

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Updated README CLI command examples to consistently use single quotes for argument values in transactional send and templates create commands.

Bash history expansion treats ! inside double quotes specially,
causing dquote> mode when copy-pasting the examples. Switch to
single quotes for --subject 'Welcome!' and --body-html '<h1>Hi!</h1>'.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Apr 21, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 77478ee5-7945-4f89-a677-29c155a40422

📥 Commits

Reviewing files that changed from the base of the PR and between 8816c52 and 7ed3715.

📒 Files selected for processing (1)
  • README.md

📝 Walkthrough

Walkthrough

Documentation updates to README.md examples, converting double-quoted argument values to single-quoted format in CLI commands for transactional send and templates create operations.

Changes

Cohort / File(s) Summary
Documentation Examples
README.md
Updated CLI command examples to use single-quoted argument values for --subject, --html, and --body-html parameters in transactional send and templates create commands.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

Quotes have shifted from double to single, ✨
The examples now sparkle and gently jingle,
CLI commands dressed in apostrophe's grace,
A cleaner appearance in every case! 🐰

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately describes the main change: converting double quotes to single quotes in README examples to prevent Bash history expansion with exclamation marks.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@solovey23 solovey23 merged commit aced56e into mailtrap:main Apr 21, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant