Skip to content
This repository was archived by the owner on Jun 1, 2023. It is now read-only.

Commit d4eb762

Browse files
committed
Add note about swift-doc vs. swift doc usage
Resolves #85
1 parent 5da4946 commit d4eb762

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,12 @@ $ make install
5757
files
5858
diagram Generates diagram of Swift symbol relationships
5959

60+
> **Note**:
61+
> The `swift` driver provides extensibility through subcommands.
62+
> If you type an unknown subcommand like `swift foo`,
63+
> the system looks for a command called `swift-foo` in your `PATH`.
64+
> This mechanism allows `swift-doc` to be run either directly or as `swift doc`.
65+
6066
#### swift-doc generate
6167

6268
OVERVIEW: Generates Swift documentation

0 commit comments

Comments
 (0)