From d4eb762983a6c5cf11fccbf582003dc7c7e76019 Mon Sep 17 00:00:00 2001 From: Mattt Date: Mon, 20 Apr 2020 05:02:35 -0700 Subject: [PATCH 1/2] Add note about swift-doc vs. swift doc usage Resolves #85 --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index 80d23add..ff8b669d 100644 --- a/README.md +++ b/README.md @@ -57,6 +57,12 @@ $ make install files diagram Generates diagram of Swift symbol relationships +> **Note**: +> The `swift` driver provides extensibility through subcommands. +> If you type an unknown subcommand like `swift foo`, +> the system looks for a command called `swift-foo` in your `PATH`. +> This mechanism allows `swift-doc` to be run either directly or as `swift doc`. + #### swift-doc generate OVERVIEW: Generates Swift documentation From 1fc25430d5aa3f8e73734266e361e43ec042c515 Mon Sep 17 00:00:00 2001 From: Mattt Date: Mon, 20 Apr 2020 05:04:05 -0700 Subject: [PATCH 2/2] Add changelog entry for swift-doc vs. swift doc in README --- Changelog.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/Changelog.md b/Changelog.md index c8e3f5b2..e5c53317 100644 --- a/Changelog.md +++ b/Changelog.md @@ -18,6 +18,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - Changed Home page to display globals for HTML format. #81 by @kean. +- Changed README to clarify use of `swift-doc` vs. `swift doc` + on the command line. + #89 by @mattt. ### Fixed