display arguments as term lists in docc-flavored markdown generation#754
display arguments as term lists in docc-flavored markdown generation#754heckj merged 5 commits intoapple:mainfrom
Conversation
| @Option( | ||
| name: .shortAndLong, | ||
| help: "Use docc flavored markdown for the generated output.") | ||
| var doccFlavored: Bool = false |
There was a problem hiding this comment.
I think I might prefer an option more like --style <github|docc>
There was a problem hiding this comment.
Easy change, I'll set it up.
- added a Boolean to distinguish regular (GH-flavored) markdown from docc-flavored markdown - represent the arguments in generated files with term lists for the docc-flavored variant - updated the snapshot tests to work both GH and DocC flavored markdown generation - removed an added "\n" in the recording of content for snapshot tests, which caused the snapshot tests some issues (recorded tests with new values wouldn't pass on second-run)
… and accepting as 'docc' as an alternative
…o match generate reference
|
I went through and renamed the plugin to I'm totally game to run through and rename it again in the future, but we'll probably want to wrangle that alongside a major semver version bump, since we're renaming the whole executable of the plugin. |
|
@heckj this plugin has never been included in a release so I'm not sure how changing the name could ever be breaking. |
|
The soundness checks asserted it was a breaking change, and I wanted to make the rest of this easier rather than piling up deltas. I'll open a new PR to change the name of the plugin. I think swiftly is already using it as it stands, so there may need to be a coordinated PR with them to keep from breaking their CI workflows as we adjust. I'll dig and get it set up. |
|
@swift-ci please test |
3 participants
resolves #721
Checklist