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

Commit 2dc9912

Browse files
authored
Merge pull request #89 from SwiftDocOrg/subcommand-documentation
Add note about swift-doc vs. swift doc usage
2 parents bd4df9b + 1fc2543 commit 2dc9912

File tree

2 files changed

+9
-0
lines changed

2 files changed

+9
-0
lines changed

Changelog.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
1818

1919
- Changed Home page to display globals for HTML format.
2020
#81 by @kean.
21+
- Changed README to clarify use of `swift-doc` vs. `swift doc`
22+
on the command line.
23+
#89 by @mattt.
2124

2225
### Fixed
2326

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)