Skip to content

Commit

Permalink
clarify the magic comment
Browse files Browse the repository at this point in the history
  • Loading branch information
UnderpantsGnome committed Oct 3, 2012
1 parent d1b5e21 commit 7459d8c
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions README.md
Expand Up @@ -134,6 +134,8 @@ fi
# lots more bash...
```

The magic comment looks like `# Provide your_sub_name completions`

Passing the `--complete` flag to this subcommand short circuits the real command, and then runs another subcommand instead. The output from your subcommand's `--complete` run is sent to your shell's autocompletion handler for you, and you don't ever have to once worry about how any of that works!

Run the `init` subcommand after you've prepared your sub to get your sub loading automatically in your shell.
Expand Down

0 comments on commit 7459d8c

Please sign in to comment.