Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add escaping control characters info to readme.md #71

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add escaping control characters info to readme.md #71

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,8 @@ $ tb --help
$ tb
$ tb --task Make some buttercream
$ tb --task @coding Improve documentation
$ tb --task @coding Improve documentation\'s \"Create Task\" \& \"Create Note\" sections
$ tb --task @coding "Improve documentation's \"Create Task\" & \"Create Note\" sections"
$ tb --task @coding @reviews Review PR #42
$ tb --note @coding Mergesort worse-case O(nlogn)
$ tb --check 1 2
Expand Down Expand Up @@ -179,6 +181,18 @@ To create a new task use the `--task`/`-t` option with your task's description f
$ tb -t Improve documentation
```

The shell reserves a number of common characters as control characters, e.g., `\`, `'`, `"`, `&`. To use these characters in your description use the shell escape character `\` before the control character.

```
$tb -t Improve documentation\'s \"Create Task\" \& \"Create Note\" sections
```

Alternatively you may enclose the text to be escaped in double-quotes making sure to escape any contained double-quotes.

```
$tb -t "Improve documentation's \"Create Task\" & \"Create Note\" sections"
```

### Create Note

To create a new note use the `--note`/`-n` option with your note's body following right after.
Expand Down