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

super minor tweak to README & warning emit in generate #92

Merged
merged 6 commits into from
Apr 23, 2020

Conversation

heckj
Copy link
Contributor

@heckj heckj commented Apr 22, 2020

this may be me just being an idiot, but I completely missed source vs. sources in the README example for using the wiki code generation example, and burned hours hunting it down. For the example, I think it would be awesome if it matched up with the default so that others don't stub their toes on this particular nit.

I also made a minor tweak (separate commit) to emit a warning so that at least some output appears when it fails to find any source files to generate against.

related to #86

@heckj heckj changed the title super minor tweak to README super minor tweak to README & warning emit in generate Apr 22, 2020
@heckj heckj changed the title super minor tweak to README & warning emit in generate super minor tweak to README & warning emit in generate Apr 22, 2020
@mattt
Copy link
Contributor

mattt commented Apr 22, 2020

@heckj I'm so glad to hear that you finally figured that out, though I'm obviously not thrilled by how much time you had to spend chasing that down. I think the proposed changes to the documentation and code is absolutely spot-on, and will go a long way to helping others avoid having the same issue.

@mattt
Copy link
Contributor

mattt commented Apr 22, 2020

Oh, one more thing – please add lines to the Changelog under the section "Fixed" for the README change and under "Updated" for the logger message change.

@heckj heckj requested a review from mattt April 22, 2020 21:58
mattt and others added 2 commits April 23, 2020 05:51
Co-Authored-By: Max Desiatov <[email protected]>
Co-Authored-By: Max Desiatov <[email protected]>
@mattt
Copy link
Contributor

mattt commented Apr 23, 2020

@heckj Perfect. Thanks again for your help. This goes a long way to making swift-doc more usable. I'll merge this in as soon as CI gives me a ✅ .

@MaxDesiatov Gosh, how I love GitHub's "suggestions in PRs" feature. Thanks for jumping in on these!

@mattt mattt merged commit 4387e56 into SwiftDocOrg:master Apr 23, 2020
@heckj
Copy link
Contributor Author

heckj commented Apr 23, 2020

Thanks for the updates last night! I crashed hard.

@heckj heckj deleted the readme-tweak branch April 23, 2020 14:17
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants