Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[SR-15316] [Swift-DocC] Emit a warning when a Topics section is written without a subheading #57638

Closed
ethan-kusters opened this issue Oct 13, 2021 · 1 comment
Closed

[SR-15316] [Swift-DocC] Emit a warning when a Topics section is written without a subheading #57638

ethan-kusters opened this issue Oct 13, 2021 · 1 comment
Labels
bug DiagnosticsQoI StarterBug

Comments

@ethan-kusters
Copy link
Contributor

@ethan-kusters ethan-kusters commented Oct 13, 2021

Previous ID SR-15316
Radar rdar://58875480
Original Reporter @ethan-kusters
Type Bug
Status Resolved
Resolution Done
Additional Detail from JIRA
Votes 0
Component/s Swift-DocC
Labels Bug, DiagnosticsQol, StarterBug
Assignee maldahleh (JIRA)
Priority Medium

md5: 1e9985f00dbb5c1b1959ca90b9b4237a

Issue Description:

Swift-DocC requires all Topics sections to include at least one subheading or it drops the Topics section altogether. If Swift-DocC encounters a Topics section with no subheadings during compilation, a warning should be emitted to help users understand why their content is not being rendered.
@swift-ci
Copy link
Collaborator

@swift-ci swift-ci commented Nov 8, 2021

Comment by Mohammed Al-Dahleh (JIRA)

PR: apple/swift-docc#29

@swift-ci swift-ci transferred this issue from apple/swift-issues Apr 25, 2022
This issue was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
bug DiagnosticsQoI StarterBug
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@shahmishal @ethan-kusters @swift-ci