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

Commit 4387e56

Browse files
authored
Merge pull request #92 from heckj/readme-tweak
Update README and add logging statement to generate command
2 parents 2dc9912 + d18f596 commit 4387e56

File tree

3 files changed

+10
-2
lines changed

3 files changed

+10
-2
lines changed

Changelog.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
2121
- Changed README to clarify use of `swift-doc` vs. `swift doc`
2222
on the command line.
2323
#89 by @mattt.
24+
- Changed the `generate` command to emit a warning if no source
25+
files are found.
26+
#92 by @heckj
2427

2528
### Fixed
2629

@@ -30,6 +33,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
3033
#62 by @victor-pavlychko.
3134
- Fixed rendering of protocol requirements in the HTML version.
3235
#76 by @victor-pavlychko.
36+
- Fixed default location of sources reference in README
37+
#92 by @heckj
3338

3439
## [1.0.0-beta.2] - 2020-04-08
3540

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -238,7 +238,7 @@ jobs:
238238
- name: Generate Documentation
239239
uses: SwiftDocOrg/swift-doc@master
240240
with:
241-
inputs: "Source"
241+
inputs: "Sources"
242242
module-name: MyLibrary
243243
output: "Documentation"
244244
- name: Upload Documentation to Wiki

Sources/swift-doc/Subcommands/Generate.swift

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,10 @@ extension SwiftDoc {
7272
pages[path(for: name)] = GlobalPage(module: module, name: name, symbols: symbols)
7373
}
7474

75-
guard !pages.isEmpty else { return }
75+
guard !pages.isEmpty else {
76+
logger.warning("No public API symbols were found at the specified path. No output was written.")
77+
return
78+
}
7679

7780
if pages.count == 1, let page = pages.first?.value {
7881
let filename: String

0 commit comments

Comments
 (0)